Get Webhook Key By Name

GET

agent_api_keys

name

{name}

Return named API key for the agent ID

curl --request GET \
  --url https://api.example.com/agent_api_keys/name/{name}

{
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>"
}

Path Parameters

name

string

required

Query Parameters

agent_id

string | null

agent_name

string | null

api_key_type

enum<string>

default:external

Available options:

internal,

external,

github,

slack

Response

Successful Response

agent_id

string

required

The UUID of the agent

api_key_type

enum<string>

required

The type of the agent API key (either internal or external)

Available options:

internal,

external,

github,

slack

created_at

string<date-time>

required

When the agent API key was created

string

required

The unique identifier of the agent API key.

name

string | null

required

The optional name of the agent API key.

Delete Webhook KeyDelete API key by ID.

Return named API key for the agent ID

curl --request GET \
  --url https://api.example.com/agent_api_keys/name/{name}

{
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>"
}