Product keys

Product API key lifecycle operations.

List product keys

GET

https://api.pokerworks.io

/api/v1/management/product-keys

List product API keys visible to an authenticated management token

List product keys › Responses

ProductKeysResponse

object[] · required

Create product key

POST

https://api.pokerworks.io

/api/v1/management/product-keys

Create a reveal-once product API key using a management token

Create product key › Request Body

CreateProductKeyRequest

environment

string · enum · required

Enum values:

test

live

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

expiresAt

string · date-time

scopes

string[] · minItems: 1 · maxItems: 10

Enum values:

calculations:read

usage:read

org:read

Create product key › Responses

CreateProductKeyResponse

object · required

secret

string · required

POST/api/v1/management/product-keys

curl https://api.pokerworks.io/api/v1/management/product-keys \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "environment": "test",
  "expiresAt": "2024-08-25T15:00:00Z",
  "label": "label",
  "projectId": "projectId",
  "scopes": [
    "calculations:read"
  ]
}'

Example Request Body

{
  "environment": "test",
  "expiresAt": "2024-08-25T15:00:00Z",
  "label": "label",
  "projectId": "projectId",
  "scopes": [
    "calculations:read"
  ]
}

json

Example Responses

{
  "key": {
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "expiresAt": "2024-08-25T15:00:00Z",
    "id": "id",
    "label": "label",
    "lastUsedAt": "2024-08-25T15:00:00Z",
    "masked": "masked",
    "organizationId": "organizationId",
    "prefix": "prefix",
    "projectId": "projectId",
    "scopes": [
      "calculations:read"
    ],
    "status": "active"
  },
  "secret": "secret"
}

json

application/json

Revoke product key

POST

https://api.pokerworks.io

/api/v1/management/product-keys/{keyId}/revoke

Revoke a product API key using a management token

Revoke product key › path Parameters

keyId

string · required

Parameter keyId.

Revoke product key › Responses

RevokeProductKeyResponse

object · required

Projects Rooms

PokerWorks Management API

Product keys

Product API key lifecycle operations.

List product keys

GET

https://api.pokerworks.io

/api/v1/management/product-keys

List product API keys visible to an authenticated management token

List product keys › Responses

ProductKeysResponse

object[] · required

Create product key

POST

https://api.pokerworks.io

/api/v1/management/product-keys

Create a reveal-once product API key using a management token

Create product key › Request Body

CreateProductKeyRequest

environment

string · enum · required

Enum values:

test

live

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

expiresAt

string · date-time

scopes

string[] · minItems: 1 · maxItems: 10

Enum values:

calculations:read

usage:read

org:read

Create product key › Responses

CreateProductKeyResponse

object · required

secret

string · required

POST/api/v1/management/product-keys

curl https://api.pokerworks.io/api/v1/management/product-keys \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "environment": "test",
  "expiresAt": "2024-08-25T15:00:00Z",
  "label": "label",
  "projectId": "projectId",
  "scopes": [
    "calculations:read"
  ]
}'

Example Request Body

{
  "environment": "test",
  "expiresAt": "2024-08-25T15:00:00Z",
  "label": "label",
  "projectId": "projectId",
  "scopes": [
    "calculations:read"
  ]
}

json

Example Responses

{
  "key": {
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "expiresAt": "2024-08-25T15:00:00Z",
    "id": "id",
    "label": "label",
    "lastUsedAt": "2024-08-25T15:00:00Z",
    "masked": "masked",
    "organizationId": "organizationId",
    "prefix": "prefix",
    "projectId": "projectId",
    "scopes": [
      "calculations:read"
    ],
    "status": "active"
  },
  "secret": "secret"
}

json

application/json

Revoke product key

POST

https://api.pokerworks.io

/api/v1/management/product-keys/{keyId}/revoke

Revoke a product API key using a management token

Revoke product key › path Parameters

keyId

string · required

Parameter keyId.

Revoke product key › Responses

RevokeProductKeyResponse

object · required

Projects Rooms