COconekta
Api Keys

Delete Api Key

Deletes a api key that corresponds to a api key ID

delete/api_keys/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Response

successful

activeboolean

Indicates if the api key is active

created_atinteger

Unix timestamp in seconds of when the api key was created

descriptionstring

A name or brief explanation of what this api key is used for

livemodeboolean

Indicates if the api key is in production

prefixstring

The first few characters of the authentication_token

idstring

Unique identifier of the api key

objectstring

Object name, value is 'api_key'

last_used_atinteger nullable

Unix timestamp in seconds with the api key was used

rolestring

Indicates if the api key is private or public

deletedboolean

Example response

{
  "active": true,
  "created_at": 1684167881,
  "description": "online store",
  "prefix": "key_rp",
  "id": "64625cc9f3e02c00163f5e4d",
  "object": "api_key",
  "role": "private",
  "deleted": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.