Start free

API keys API

Create, roll and delete organization API keys. A new key is shown once.

OperationMethod and path
List API keysGET /api/v1/api-key
Create an API key (the key is shown once)POST /api/v1/api-key
Delete an API keyDELETE /api/v1/api-key/{id}
Replace an API key with a new secretPOST /api/v1/api-key/{id}/roll
GET /api/v1/api-key

List API keys

apiKey.list · requires x-api-key

Parameters

NameInTypeNotes
offset query integer
limit query integer
q query string

Example

curl -X GET "https://api.siaran.my/api/v1/api-key" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

2 top-level fields
  • items object[] required
    5 fields
    • id string required
    • name string required
    • prefix string required
    • lastUsedAt string nullable date-time
    • createdAt string date-time
  • total integer required
POST /api/v1/api-key

Create an API key (the key is shown once)

apiKey.create · requires x-api-key

Request body application/json

  • name string required

Example

curl -X POST "https://api.siaran.my/api/v1/api-key" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Example"
  }'

Response 201

5 top-level fields
  • id string required
  • name string
  • prefix string
  • key string required
  • createdAt string date-time
DELETE /api/v1/api-key/{id}

Delete an API key

apiKey.delete · requires x-api-key

Parameters

NameInTypeNotes
id required path string

Example

curl -X DELETE "https://api.siaran.my/api/v1/api-key/ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

1 top-level fields
  • success boolean required
POST /api/v1/api-key/{id}/roll

Replace an API key with a new secret

apiKey.roll · requires x-api-key

Parameters

NameInTypeNotes
id required path string

Example

curl -X POST "https://api.siaran.my/api/v1/api-key/ID/roll" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

5 top-level fields
  • id string required
  • name string
  • prefix string
  • key string required
  • createdAt string date-time