Delete API key

DELETE 
/v2/config/admin/apikey/:apiKeyId

Deletes an API key. The service marks the key as deleted and stops accepting it. The key no longer shows in the list of API keys.

The token itself stays valid in form until its expiry, but the service refuses it, so every client that uses it must move to another key.

Request

Path Parameters

apiKeyId stringrequired

Unique ID of an object

Responses

200

The service deleted the API key and returns the key as it was at the moment of the delete.

Response Headers

application/json

Schema

Schema

apiKey objectrequired

The API key that the service deleted.

id stringrequired

Unique identifier of the API key.

name stringrequired

Name of the API key. The service does not check this value for uniqueness.

scopes string[]required

Possible values: [config, audit, service, onboard]

Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400.

apiKey stringrequired

The signed JSON Web Token. Send it as Authorization: ApiKey <apiKey>. The token holds the scopes, the organisation, the organisation administrator and, when the key is bound to a sandbox organisation, the sandbox organisation.

expiryInDays integerrequired

Default value: 30

Lifetime of the API key in days, counted from the moment the service created or last updated the key. The service uses 30 days when you send 0 or a negative value.

timestamp date-timerequired

Moment when the service last wrote the API key, in UTC. The service sets this value on create and on every update, including the delete operation.

expiryTimestamp date-timerequired

Moment when the API key expires, in UTC.

type stringrequired

Possible values: [igrantio, aip10]

Type of the API key. The list operation returns only keys of type igrantio; these are the keys that you create with this group of operations.

sandboxOrgId string

Identifier of the sandbox organisation that the API key is bound to. The field is absent when the key belongs to the main wallet of the organisation.

createdBy objectrequired

The user who created the API key, and the moment of creation. The service keeps this as log metadata.

id stringrequired

Identifier of the user who created the API key. The value is an empty string for a key created with an API key.

email stringrequired

Email address of the user who created the API key.

at date-timerequired

Moment of creation, in UTC.

Example (from schema)

{
  "apiKey": {
    "id": "6889e1a4c5b2f30001a3d720",
    "name": "Production issuance key",
    "scopes": [
      "config",
      "service"
    ],
    "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...",
    "expiryInDays": 30,
    "timestamp": "2026-08-09T10:15:30Z",
    "expiryTimestamp": "2026-09-08T10:15:30Z",
    "type": "igrantio",
    "sandboxOrgId": "6889e1a4c5b2f30001a3d710",
    "createdBy": {
      "id": "6889e1a4c5b2f30001a3d6e0",
      "email": "[email protected]",
      "at": "2026-08-09T10:15:30Z"
    }
  }
}

Example

{
  "apiKey": {
    "id": "6889e1a4c5b2f30001a3d720",
    "name": "Production issuance key",
    "scopes": [
      "config"
    ],
    "apiKey": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTY29wZXMiOlsiY29uZmlnIl0...",
    "expiryInDays": 30,
    "timestamp": "2026-08-09T12:40:05Z",
    "expiryTimestamp": "2026-09-08T10:15:30Z",
    "type": "igrantio",
    "createdBy": {
      "id": "6889e1a4c5b2f30001a3d6e0",
      "email": "[email protected]",
      "at": "2026-08-09T10:15:30Z"
    }
  }
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

403

The caller has no permission for this operation. Only an organisation administrator can manage API keys.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error. The service also returns this status when the API key of apiKeyId does not exist, or when it is already deleted.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...