Canary API Docs

# Virtual Canaries

These are a collection of endpoints related to Virtual Canaries. Currently, this includes CanaryVM (for VMWare) and Hyper-V Canaries.

Endpoints
GET /api/v1/canaryvm/download
GET /api/v1/canaryvm/downloadseed
GET /api/v1/hypervcanary/download
GET /api/v1/hypervcanary/downloadseed

# Download CanaryVM Image

GET /api/v1/canaryvm/download

Returns a URL to the versioned CanaryVM Image.

Required Parameters

auth_token string
A valid auth token
version string
A valid CanaryVM version

Optional Parameters

format string
Defaults to: vmx
The format of the Virtual Canary archive. Options are: vmx and ova

Response

A JSON Structure containing the download URL for the specified version of the CanaryVM image.

Example

curl https://EXAMPLE.canary.tools/api/v1/canaryvm/download \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d version=EXAMPLE_VERSION \
  -G

  
        Copied!
1
2
3
4
Response
{
  "link": "<download_link>",
  "result": "success"
}

  
        Copied!
1
2
3
4

# Download CanaryVM Image Seed Data

WARNING

You are likely looking for Download CanaryVM Image. This endpoint is specifically used to download the seed data that gets attached to the 2nd hard drive in very rare cases where you need to replace it.

GET /api/v1/canaryvm/downloadseed

Returns a URL to the versioned CanaryVM Image Seed Data.

Required Parameters

auth_token string
A valid auth token
version string
A valid CanaryVM version

Response

A JSON Structure containing the URL for the specified version of the CanaryVM image seed file.

Example

curl https://EXAMPLE.canary.tools/api/v1/canaryvm/downloadseed \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d version=EXAMPLE_VERSION \
  -G

  
        Copied!
1
2
3
4
Response
{
  "result": "success",
  "seedlink": "<seed_link>"
}

  
        Copied!
1
2
3
4

# Download Hyper-V Canary Image

GET /api/v1/hypervcanary/download

Returns a URL to the versioned Hyper-V Canary Image.

Required Parameters

auth_token string
A valid auth token
version string
A valid Hyper-V Canary version
format string
Format of the Hyper-V Canary archive. Options are: zip

Response

A JSON Structure containing the download URL for the specified version of the Hyper-V Canary image.

Example

curl https://EXAMPLE.canary.tools/api/v1/hypervcanary/download \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d version=EXAMPLE_VERSION \
  -d format=zip \
  -G

  
        Copied!
1
2
3
4
5
Response
{
  "link": "<download_link>",
  "result": "success"
}

  
        Copied!
1
2
3
4

# Download Hyper-V Canary Image Seed Data

WARNING

You are likely looking for Download Hyper-V Canary Image. This endpoint is specifically used to download the seed data that gets attached to the 2nd hard drive in very rare cases where you need to replace it.

GET /api/v1/hypervcanary/downloadseed

Returns a URL to the versioned Hyper-V Canary Image Seed Data.

Required Parameters

auth_token string
A valid auth token
version string
A valid Hyper-V Canary version

Response

A JSON Structure containing the URL for the specified version of the Hyper-V Canary image seed file.

Example

curl https://EXAMPLE.canary.tools/api/v1/hypervcanary/downloadseed \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d version=EXAMPLE_VERSION \
  -G

  
        Copied!
1
2
3
4
Response
{
  "result": "success",
  "seedlink": "<seed_link>"
}

  
        Copied!
1
2
3
4

← Overview →