Flock API Keys

Create a new Flock specific API key.

Endpoints

POST /api/v1/flock/auth_token/add

POST /api/v1/flock/auth_token/remove

GET /api/v1/flock/auth_token/list

Add Flock API Keys

POST /api/v1/flock/auth_token/add

Create a new Flock specific API key.

Required Parameters

auth_token string

A valid auth token

flock_id string

A valid flock_id

note string

A note for the Flock API key on who/where it is used.

Optional Parameters

auth_token_type string

The access level of the key. Either 'read-only', 'analyst', or 'admin'

Response

A JSON structure with the new Flock API Key.

Example

curl -X POST https://EXAMPLE.canary.tools/api/v1/flock/auth_token/add \
  -d auth_token=EXAMPLE_AUTH_TOKEN  \
  -d flock_id=EXAMPLE_FLOCK_ID \
  -d note=EXAMPLE_NOTE

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/auth_token/add'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'flock_id': 'EXAMPLE_FLOCK_ID',
  'note': 'EXAMPLE_NOTE'
}

r = requests.post(url, params=payload)

print(r.json())

Response

{
  "flock_api_key": {
    "auth_token": "<flock_auth_token>",
    "auth_token_type": "admin",
    "created": "2023-04-14 09:23:22 UTC+0000",
    "created_by": "Global-API-Token[key_id:ffffffff]",
    "key_id": "<key_id>",
    "managed_flocks": [
      "flock:<flock_id>"
    ],
    "note": "Example Memo",
    "watched_flocks": []
  },
  "result": "success"
}

Remove Flock API key

POST /api/v1/flock/auth_token/remove

Delete an existing Flock specific API key.

Required Parameters

auth_token string

A valid auth token

remove_auth_token string

A valid existing Flock specific auth token.

Response

A JSON structure with the result indicator.

Example

curl -X POST https://EXAMPLE.canary.tools/api/v1/flock/auth_token/remove \
  -d auth_token=EXAMPLE_AUTH_TOKEN  \
  -d remove_auth_token=EXAMPLE_FLOCK_AUTH_TOKEN \
  -G

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/auth_token/remove'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'remove_auth_token': 'EXAMPLE_FLOCK_AUTH_TOKEN'
}

r = requests.post(url, params=payload)

print(r.json())

Response

{
  "result": "success"
}

List Flock API keys

GET /api/v1/flock/auth_token/list

List all API keys assigned to a specific flock.

Required Parameters

auth_token string

A valid auth token

flock_id string

A valid flock_id

Response

A JSON structure with the Flock specific auth tokens.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/auth_token/list \
  -d auth_token=EXAMPLE_AUTH_TOKEN  \
  -d flock_id=EXAMPLE_FLOCK_ID \
  -G

import requests

url = 'https://EXAMPLE.canary.tools/api/v1/flock/auth_token/list'

payload = {
  'auth_token': 'EXAMPLE_AUTH_TOKEN',
  'flock_id': 'EXAMPLE_FLOCK_ID'
}

r = requests.get(url, params=payload)

print(r.json())

Response

{
  "flock_api_keys": [
    {
      "auth_token": "<Flock Auth Token>",
      "auth_token_type": "admin",
      "created": "2023-04-13 08:58:39 UTC+0000",
      "created_by": "admin@inyoni.co.za",
      "key_id": "<Key ID>",
      "managed_flocks": [
        "flock:<Flock ID>"
      ],
      "note": "Example Note",
      "watched_flocks": []
    },
    {
      "auth_token": "<Flock Auth Token>",
      "auth_token_type": "admin",
      "created": "2023-04-14 09:28:45 UTC+0000",
      "created_by": "Global-API-Token[key_id:ffffffff]",
      "key_id": "<Key ID>",
      "managed_flocks": [
        "flock:<Flock ID>"
      ],
      "note": "Example Note",
      "watched_flocks": []
    }
  ],
  "result": "success"
}