WSwso2
Platform Gateway

Get all REST API keys for platform gateway bulk sync

Changed on

Returns all active API-scoped keys for the APIs currently deployed on the authenticated platform gateway. Intended for on-connect backfill by the gateway controller. Authenticated via api-key header (platform gateway registration token).

get/apis/api-keys

Request

  • Base URL
    https://apim.wso2.com/v1
  • URL
    https://apim.wso2.com/v1/apis/api-keys
  • Auth
    none declared. Required headers: api-key

Headers

api-keystring required

Platform gateway registration token.

Response

Array of active API keys.

uuidstring

Unique identifier of the API key.

namestring

Human-readable name of the API key.

maskedApiKeystring

Masked representation of the API key (plaintext is not stored).

apiKeyHashesobject

Map of hash algorithm to hash value, e.g. {"sha256":"<hex>"}.

artifactUuidstring

UUID of the API this key is scoped to.

statusstring

Key status, e.g. ACTIVE.

createdAtstring

ISO-8601 creation timestamp.

createdBystring

Username that created this key.

updatedAtstring

ISO-8601 last-updated timestamp.

expiresAtstring

ISO-8601 expiry timestamp. Absent if the key never expires.

etagstring

Opaque version tag for cache validation.

sourcestring

Origin of the key, e.g. 'external'.

externalRefIdstring

External reference identifier.

issuerstring

Issuer identifier.

Changes