API Keys

Operations for managing API keys including retrieving and editing API key configurations.

Get API Key

get

This endpoint retrieves an API key and its respective properties. Note: the 'roles' field refers to the 'pretty_name' attributes from the Roles APIs, not the unique role identifiers. For possible 'security_level' values, please refer to the enum documentation for 'SecurityLevel'.

Path parameters

api_key_idintegerRequired

Full API key ID

Responses

200

Successfully retrieved API key

application/json

dataobjectRequired

400

Bad request for api key get call

application/json

401

Unauthorized access

application/json

403

Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.

application/json

500

Internal server error. A unified status for API communication type errors.

get/platform/iam/v1/api-key/{api_key_id}

GET /platform/iam/v1/api-key/{api_key_id} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Accept: */*

{
  "data": {
    "id": 123,
    "creation_time": 1640024700241,
    "created_by": "test user",
    "user_name": "user_name",
    "roles": [
      "role 01"
    ],
    "security_level": "standard",
    "comment": "useful comment",
    "expiration": 1640024700241
  }
}

Edit an API key

put

This endpoint allows for the editing of an existing API key. For possible 'security_level' values, please refer to the enum documentation for 'SecurityLevel'.

Path parameters

api_key_idintegerRequired

Full API key ID

Body

Request object for editing an existing API key

Responses

200

API key edited successfully

application/json

400

Bad request for api key edit call

application/json

401

Unauthorized access

application/json

403

Unauthorized access due to lack of sufficient permissions. This includes Instance Administrator privilege escalation errors: non-admin API keys cannot assign, modify, or delete entities that have the Instance Administrator role.

application/json

500

Internal server error. A unified status for API communication type errors.

put/platform/iam/v1/api-key/{api_key_id}

PUT /platform/iam/v1/api-key/{api_key_id} HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "request_data": {
    "roles": [
      "role_name_123"
    ],
    "security_level": "standard",
    "comment": "useful comment"
  }
}

{
  "data": {
    "message": "API key updated successfully"
  }
}