Canary API Docs

# Container Canaries

These are a collection of endpoints related to Container Canaries. Currently, these relate to Docker Canaries.

Endpoints
GET /api/v1/containercanary/images

# List Container Canary Images

GET /api/v1/containercanary/images

Returns a list of available Container Canary Images

Required Parameters

auth_token string
A valid auth token

Response

A JSON Structure containing a list of available Container Canary images.

Example

curl https://EXAMPLE.canary.tools/api/v1/containercanary/images \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -G

  
        Copied!
1
2
3
Response
{
  "docker": [],
  "result": "success"
}

  
        Copied!
1
2
3
4

← Notes →