Skip to main content
POST
Revoke an EPCIS capture key

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
key_id
string<shortuuid>
required

Identifier of the key, as listed.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

One EPCIS capture key. The secret is shown once, when the key is created, and never again.

id
string<shortuuid>
required

Identifier of the key, for revoking it.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Label the key was given, such as the device or system that uses it.

prefix
string
required

First 8 characters of the secret, to tell keys apart. It is not enough to use the key.

is_active
boolean
required

False once the key is revoked; a revoked key captures nothing.

expires_at
string<date-time> | null
required

When the key stops working; null for a key that never expires.

last_used_at
string<date-time> | null
required

When the key last captured an event; null if never used.

created
string<date-time>
required

When the key was created.