ApiAccessManagement

List API keys

get

Authorizations

bearerAuth

Query parameters

PageNumberinteger · int32Optional

Current page number. Default value is 1.

PageSizeinteger · int32Optional

Maximum page size is 200. Default page size is 30.

environmentIdinteger · int64Optional

Optional environment id to filter by

Responses

200

Success

application/json

404

Environment not found

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/api-management/access/api-keys HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "name": "text",
    "id": 1,
    "value": "123e4567-e89b-12d3-a456-426614174000",
    "modified": "2025-09-07T10:06:08.452Z",
    "modifier": "text",
    "environment": {
      "id": 1,
      "displayName": "text"
    }
  }
}

Create API key

post

Authorizations

bearerAuth

Body

application/json

namestring | nullableOptional

Name of the API key

environmentIdinteger · int64Optional

Identifier of the Environment of the API key

Responses

201

API key created

application/json

400

Bad Request

application/problem+json

post

HTTPcURLJavaScriptPython

POST /api/v1/api-management/access/api-keys HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "environmentId": 1
}

{
  "data": {
    "name": "text",
    "id": 1,
    "value": "123e4567-e89b-12d3-a456-426614174000",
    "modified": "2025-09-07T10:06:08.452Z",
    "modifier": "text",
    "environment": {
      "id": 1,
      "displayName": "text"
    }
  }
}

Get a single API key

get

Authorizations

bearerAuth

Path parameters

idinteger · int64Required

API key identifier

Responses

200

Success

application/json

404

API key not found

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/api-management/access/api-keys/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "name": "text",
    "id": 1,
    "value": "123e4567-e89b-12d3-a456-426614174000",
    "modified": "2025-09-07T10:06:08.452Z",
    "modifier": "text",
    "environment": {
      "id": 1,
      "displayName": "text"
    }
  }
}

Update API key

put

Authorizations

bearerAuth

Path parameters

idinteger · int64Required

API key identifier

Body

application/json

namestring | nullableOptional

Name of the API key

Responses

204

API key updated

No content

404

API key not found

application/problem+json

put

HTTPcURLJavaScriptPython

PUT /api/v1/api-management/access/api-keys/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Delete API key

delete

Authorizations

bearerAuth

Path parameters

idinteger · int64Required

API key identifier

Responses

204

API key deleted

No content

404

API key not found

application/problem+json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/api-management/access/api-keys/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a single API key by name

get

Authorizations

bearerAuth

Path parameters

namestringRequired

API key name (case-insensitive)

Responses

200

Success

application/json

404

API key not found

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/api-management/access/api-keys/name/{name} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "name": "text",
    "id": 1,
    "value": "123e4567-e89b-12d3-a456-426614174000",
    "modified": "2025-09-07T10:06:08.452Z",
    "modifier": "text",
    "environment": {
      "id": 1,
      "displayName": "text"
    }
  }
}