# Virtual Canaries

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

# 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

Response

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

Example

    Response
    {
      "link": "<download_link>",
      "result": "success"
    }
    
    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

      Response
      {
        "result": "success",
        "seedlink": "<seed_link>"
      }
      
      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

        Response
        {
          "link": "<download_link>",
          "result": "success"
        }
        
        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

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