API Keys

APIs for managing API keys

Get existing API keys

post

Get a list of API keys filtered by expiration date, role, or ID.

Required license: Cortex AgentiX Enterprise or Cortex AgentiX Base.

Header parameters

authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr

x-xdr-auth-idstringRequired

api_key_id

Example: 2841

x-xdr-timestampstringRequired

timestamp in milliseconds

x-xdr-noncestringRequired

64 byte random string

x-child-tenant-idstringRequired

child tenant ID

Body

Responses

200

OK

application/json

post/public_api/v1/api_keys/get_api_keys

POST /public_api/v1/api_keys/get_api_keys HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
x-xdr-timestamp: text
x-xdr-nonce: text
x-child-tenant-id: text
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "request_data": {
    "filters": [
      {
        "field": "expiration",
        "operator": "gte",
        "value": 1721149909250
      }
    ]
  }
}

200

OK

{
  "reply": {
    "DATA": [
      {
        "id": 25,
        "creation_time": 1709544947832,
        "created_by": "N/A",
        "user_name": "Public API - 21",
        "roles": [
          "default"
        ],
        "security_level": "standard",
        "comment": null,
        "expiration": 1710149747184
      },
      {
        "id": 24,
        "creation_time": 1709544787367,
        "created_by": "N/A",
        "user_name": "Public API - 21",
        "roles": [
          "default"
        ],
        "security_level": "standard",
        "comment": null,
        "expiration": 1710149586852
      },
      {
        "id": 23,
        "creation_time": 1709544227320,
        "created_by": "N/A",
        "user_name": "Public API - 21",
        "roles": [
          "default"
        ],
        "security_level": "standard",
        "comment": null,
        "expiration": 1710149026834
      }
    ],
    "FILTER_COUNT": 3,
    "TOTAL_COUNT": 70
  }
}

Generate an API key

post

Generate a new API key and define the roles assigned to it and whether the security level is standard or advanced.

Required license: Cortex AgentiX Enterprise or Cortex AgentiX Base.

Header parameters

authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr

x-xdr-auth-idstringRequired

api_key_id

Example: 2841

x-xdr-timestampstringRequired

timestamp in milliseconds

x-xdr-noncestringRequired

64 byte random string

x-child-tenant-idstringRequired

child tenant ID

Body

Responses

200

OK

application/json

post/public_api/v1/api_keys/generate

POST /public_api/v1/api_keys/generate HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
x-xdr-timestamp: text
x-xdr-nonce: text
x-child-tenant-id: text
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "request_data": {
    "roles": [
      "Public API Action"
    ],
    "security_level": "standard",
    "comment": "Api key for John"
  }
}

200

OK

{
  "reply": {
    "id": 4267,
    "key": "oZFaXmXCLCdoWIXTb9ITSqUvl4OBLsUQgCeuZc5FdwMpmpY5QBn8OUePZiLMb"
  }
}

Delete API keys

post

Delete API keys by ID.

Required license: Cortex AgentiX Enterprise or Cortex AgentiX Base.

Header parameters

authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr

x-xdr-auth-idstringRequired

api_key_id

Example: 2841

x-xdr-timestampstringRequired

timestamp in milliseconds

x-xdr-noncestringRequired

64 byte random string

x-child-tenant-idstringRequired

child tenant ID

Body

Responses

200

OK

application/json

post/public_api/v1/api_keys/delete

POST /public_api/v1/api_keys/delete HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
x-xdr-timestamp: text
x-xdr-nonce: text
x-child-tenant-id: text
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "request_data": {
    "filters": [
      {
        "field": "id",
        "operator": "in",
        "value": [
          121,
          134
        ]
      }
    ]
  }
}

200

OK

{
  "reply": {
    "update_count": 2
  }
}