In this Article

Other Content

REST API Reference Guide

The Buttonwood Broker exposes REST APIs for external services to interact with and use as part of automated workflows and scripts.

This guide provides details on the REST API endpoints and their elements.

Security and Authentication

To use the Broker REST API, a user must have an activate account and must authenticate with the Broker via the use of an API Token.

This procedure provides the steps required to generate an API token for a user account. An API Token can be generated for any registered user within the Broker.

Generating an API Token

  1. Log in to the Broker UI
  2. Navigate to Admin > Control Panel
  3. Select the Users tile
  4. For the account with which to create the API Token, click View
  5. Select the API Tokens tab
  6. Click Add
  7. An API Token is created for the selected user

Usage

The API token must be placed in the Authorization header of a request in the following format.

Bearer <token>

curl Example

curl -–insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" ...

Catalog Item API Details

Programmatic details on how to deploy any published blueprint available within the published catalog item.

This procedure describes the steps required to retrieve the REST API details for a published blueprint.

  1. Log in to the Broker UI
  2. Navigate to Catalog
  3. The Catalog lists all published Blueprints which the logged in user has been granted permissions
  4. Locate the Blueprint, click the  ellipses menu to flip the tile
  5. Click API Details
  6. The catalog item REST API details are displayed
    Note: Some fields should be edited to suit the deployment requirements

GET /api/v1/catalogItem

Returns a list of published catalog items available to the token user.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/catalogItem

Example Response

{
  "catalogItems": [
    {
      "id": 321955,
      "blueprintName": "My First Blueprint",
      "environment": "Test",
      "modifiedOn": "2018-08-01T06:40:59Z",
      "category": "Blueprints"
    }
  ]
}

GET /api/v1/classification

Returns a list of classifications.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/classification

Example Response

{
  "classifications": [
    {
      "id": 109652,
      "name": "Unclassified",
      "description": "Unclassified",
      "order": 0
    },
    {
      "id": 109655,
      "name": "Protected",
      "description": "Protected",
      "order": 1
    },
    {
      "id": 109658,
      "name": "Top Secret",
      "description": "Top Secret",
      "order": 2
    }
  ]
}

GET /api/v1/costCentre

Returns a list of Cost Centres available to the token user.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/costCentre

Example Response

{
  "costCentres": [
    {
      "id": "40",
      "name": "Dev",
      "description": null
    },
    {
      "id": "41",
      "name": "Test",
      "description": "Test Cost Centre"
    }
  ]
}

GET /api/v1/deployment[?includeTerminated=true]

Returns a list of deployments for the token user.

Optional Queries

Query Data Type Description
includeTerminated boolean

true
Returned list includes terminated deployments

false
Returned list doesn't include terminated deployments

Default value:
false

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/deployment

Example Response

{
  "deployments": [
    {
      "id": "eabfe940-ce82-4157-b65d-50c741140dac",
      "name": "My First Blueprint 02",
      "description": null,
      "blueprintId": 76427,
      "hoursOfOperationMode": "CompleteSchedule",
      "blueprintName": "Single Micro g",
      "state": "Creating",
      "stateExplanation": null,
      "provisioningState": "Creating",
      "nativeCloudNetworkId": 324,
      "environmentName": "Test",
      "owner": "user1@buttonwood.int",
      "costCentreId": "41",
      "leaseStartDate": "2018-08-06T14:12:49+1100",
      "leaseEndDate": "2018-08-07T23:59:59+1100",
      "endOfLeaseAction": "Disable",
      "createdOn": "2018-08-06T14:12:49+1100",
      "createdBy": "user1@buttonwood.int",
      "modifiedOn": "2018-08-06T14:12:49+1100",
      "modifiedBy": "user1@buttonwood.int",
      "url": ""
    },
    {
      "id": "c21e2ad8-af03-4388-9c86-faaf3551ddda",
      "name": "My First Blueprint 01",
      "description": null,
      "blueprintId": 76427,
      "hoursOfOperationMode": "CompleteSchedule",
      "blueprintName": "Single Micro g",
      "state": "Running",
      "stateExplanation": "Provisioning complete",
      "provisioningState": "Created",
      "nativeCloudNetworkId": 324,
      "environmentName": "Test",
      "owner": "user1@buttonwood.int",
      "costCentreId": "41",
      "leaseStartDate": "2018-08-06T14:10:51+1100",
      "leaseEndDate": "2018-08-07T23:59:59+1100",
      "endOfLeaseAction": "Disable",
      "createdOn": "2018-08-06T14:10:52+1100",
      "createdBy": "user1@buttonwood.int",
      "modifiedOn": "2018-08-06T14:12:11+1100",
      "modifiedBy": "user1@buttonwood.int",
      "url": ""
    }
  ]
}

GET /api/v1/deployment/{externalId}

Returns details of a single deployment for the token user.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/deployment/c21e2ad8-af03-4388-9c86-faaf3551ddda

Example Response

{
  "deployment": [
    {
      "id": "c21e2ad8-af03-4388-9c86-faaf3551ddda",
      "name": "My First Blueprint 01",
      "description": null,
      "blueprintId": 76427,
      "hoursOfOperationMode": "CompleteSchedule",
      "blueprintName": "Single Micro g",
      "state": "Running",
      "stateExplanation": "Provisioning complete",
      "provisioningState": "Created",
      "nativeCloudNetworkId": 324,
      "environmentName": "Test",
      "owner": "user1@buttonwood.int",
      "costCentreId": "41",
      "leaseStartDate": "2018-08-06T14:10:51+1100",
      "leaseEndDate": "2018-08-07T23:59:59+1100",
      "endOfLeaseAction": "Disable",
      "createdOn": "2018-08-06T14:10:52+1100",
      "createdBy": "user1@buttonwood.int",
      "modifiedOn": "2018-08-06T14:12:11+1100",
      "modifiedBy": "user1@buttonwood.int",
      "url": ""
    }
  ]
}

GET /api/v1/deployment/{externalId}/artifact

Returns the details of artifacts created during a deployment.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/deployment/99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0/artifact

Example Response

{
  "artifacts": [
    {
      "id": 342015,
      "cloudResourceId": null,
      "contentType": "String",
      "key": "aria.install-2018-08-07 10:43:07.log",
      "data": "Executing ARIA command (UID 110): execute -w insta",
      "dataLength": 96399,
      "createdOn": "2018-08-07T00:43:07Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:43:07Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=342015"
    },
    {
      "id": 341958,
      "cloudResourceId": null,
      "contentType": "String",
      "key": "blueprint.yaml",
      "data": "description: Blueprint for deployment D93 - My Fir",
      "dataLength": 4005,
      "createdOn": "2018-08-07T00:42:06Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:42:06Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=341958"
    },
    {
      "id": 341957,
      "cloudResourceId": null,
      "contentType": "String",
      "key": "composer-blueprint.json",
      "data": "{\"layout\":{\"0888321f-6c14-40b9-9ff1-331a4d37c806\":",
      "dataLength": 2517,
      "createdOn": "2018-08-07T00:42:05Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:42:05Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=341957"
    },
    {
      "id": 342019,
      "cloudResourceId": null,
      "contentType": "SSHKey",
      "key": "D93.pem",
      "data": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAi3",
      "dataLength": 1670,
      "createdOn": "2018-08-07T00:43:07Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:43:07Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=342019"
    },
    {
      "id": 342016,
      "cloudResourceId": null,
      "contentType": "String",
      "key": "deployment.outputs-2018-08-07 10:43:07",
      "data": "{\"0888321f-6c14-40b9-9ff1-331a4d37c806\":{\"relation",
      "dataLength": 4612,
      "createdOn": "2018-08-07T00:43:07Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:43:07Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=342016"
    },
    {
      "id": 342000,
      "cloudResourceId": "i-0410b75de66e8208c",
      "contentType": "String",
      "key": "username",
      "data": "Administrator",
      "dataLength": 13,
      "createdOn": "2018-08-07T00:42:31Z",
      "createdBy": "",
      "modifiedOn": "2018-08-07T00:43:07Z",
      "modifiedBy": "",
      "downloadUrl": "/deployment/downloadArtifactFile?artifactId=342000"
    }
  ]
}

GET /api/v1/deployment/{externalId}/resource

Returns the details of resources created during a deployment.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/deployment/99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0/resource

Example Response

{
  "resources": [
    {
      "id": 341978,
      "name": "vpc-1a2b3c01",
      "providerResourceId": "vpc-1a2b3c01",
      "brokerResourceId": "93::0888321f-6c14-40b9-9ff1-331a4d37c806",
      "providerCode": "AWS",
      "regionCode": "ap-southeast-2",
      "providerAccount": "AWS Account 01",
      "nodeType": "net.buttonwood.broker.VPC",
      "nodeId": "0888321f-6c14-40b9-9ff1-331a4d37c806",
      "state": "Running",
      "message": "",
      "managementLink": "https://ap-southeast-2.console.aws.amazon.com/vpc/home?region=ap-southeast-2#vpcs:filter=vpc-1a2b3c01",
      "managementLinkLabel": "View in AWS Console",
      "runtimeProperties": {
        "Provider State": "available",
        "Is Default VPC?": true,
        "CIDR Block": "172.31.0.0/16"
      }
    },
    {
      "id": 342022,
      "name": "key-99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
      "providerResourceId": "key-99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
      "brokerResourceId": "93::d809013a-8e90-4afa-b59a-4de55cce2e56",
      "providerCode": "AWS",
      "regionCode": "ap-southeast-2",
      "providerAccount": "AWS Account 01",
      "nodeType": "net.buttonwood.broker.KeyPair",
      "nodeId": "d809013a-8e90-4afa-b59a-4de55cce2e56",
      "state": "Running",
      "message": "",
      "managementLink": "https://ap-southeast-2.console.aws.amazon.com/ec2/v2/home?region=ap-southeast-2#KeyPairs:search=key-99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
      "managementLinkLabel": "View in AWS Console",
      "runtimeProperties": {
        "Name": "key-99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
        "Fingerprint": "8e:20:af:74:d3:72:af:a7:7e:a3:8b:68:12:8d:95:2d:7c:85:ac:f8"
      }
    },
    {
      "id": 341998,
      "name": "vol-0dab55a99f1735c1c",
      "providerResourceId": "vol-0dab55a99f1735c1c",
      "brokerResourceId": "93::2d24f01b-a214-461c-99e9-79f5f0b2d04f",
      "providerCode": "AWS",
      "regionCode": "ap-southeast-2",
      "providerAccount": "AWS Account 01",
      "nodeType": "net.buttonwood.broker.RootVolume",
      "nodeId": "2d24f01b-a214-461c-99e9-79f5f0b2d04f",
      "state": "Running",
      "message": "",
      "managementLink": "https://ap-southeast-2.console.aws.amazon.com/ec2/v2/home?region=ap-southeast-2#Volumes:volumeId=vol-0dab55a99f1735c1c",
      "managementLinkLabel": "View in AWS Console",
      "tags": {
        "bcx-created": "user1@buttonwood.int on 2018-08-07 10:42:05 +1000",
        "bcx-deployment-id": "99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
        "bcx-brokersid": "367a6d30-413d-4644-a966-10b1e9ca5721",
        "bcx-deployment-environment": "Test",
        "bcx-node-id": "D93::0514ec85"
      },
      "runtimeProperties": {
        "Size": "20 GiB",
        "Availablity Zone": "ap-southeast-2a",
        "Created On": "2018-08-07T00:42:31Z",
        "Encrypted": "No",
        "IOPS": 100,
        "Provider State": "in-use",
        "Volume Type": "gp2",
        "Attached to": "i-0410b75de66e8208c"
      }
    },
    {
      "id": 342020,
      "name": "SG_D99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
      "providerResourceId": "sg-1a2b3c01",
      "brokerResourceId": "93::49321dac-5319-4d04-883d-ce29d6cd6d5d",
      "providerCode": "AWS",
      "regionCode": "ap-southeast-2",
      "providerAccount": "AWS Account 01",
      "nodeType": "net.buttonwood.broker.SecurityGroup",
      "nodeId": "49321dac-5319-4d04-883d-ce29d6cd6d5d",
      "state": "Running",
      "message": "",
      "managementLink": "https://ap-southeast-2.console.aws.amazon.com/ec2/v2/home?region=ap-southeast-2#SecurityGroups:groupId=sg-1a2b3c01",
      "managementLinkLabel": "View in AWS Console",
      "tags": {
        "bcx-brokersid": "367a6d30-413d-4644-a966-10b1e9ca5721",
        "bcx-deployment-environment": "Test",
        "Name": "SG_D99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
        "bcx-created": "user1@buttonwood.int on 2018-08-07 10:42:05 +1000",
        "bcx-node-id": "D93::49321dac-5319-4d04-883d-ce29d6cd6d5d",
        "bcx-deployment-id": "99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0"
      },
      "runtimeProperties": {
        "Name": "99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0-49321dac-5319-4d04-883d-ce29d6cd6d5d_e7543",
        "Description": "Security Group",
        "display_properties": [
          {
            "type": "string",
            "name": "Inbound Rules",
            "value": "[tcp] 22-22 <0.0.0.0/0>"
          },
          {
            "type": "string",
            "name": "Outbound Rules",
            "value": "[ALL] N/A <0.0.0.0/0>"
          }
        ],
        "name": "SG_D99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0"
      }
    },
    {
      "id": 341994,
      "name": "D93-vm",
      "providerResourceId": "i-0410b75de66e8208c",
      "brokerResourceId": "93::0514ec85",
      "providerCode": "AWS",
      "regionCode": "ap-southeast-2",
      "providerAccount": "AWS Account 01",
      "nodeType": "net.buttonwood.broker.Compute",
      "nodeId": "0514ec85",
      "state": "Running",
      "message": "",
      "managementLink": "https://ap-southeast-2.console.aws.amazon.com/ec2/v2/home?region=ap-southeast-2#Instances:instanceId=i-0410b75de66e8208c",
      "managementLinkLabel": "View in AWS Console",
      "tags": {
        "bcx-brokersid": "367a6d30-413d-4644-a966-10b1e9ca5721",
        "bcx-deployment-environment": "Test",
        "bcx-node-id": "D93::0514ec85",
        "Name": "D93-vm",
        "bcx-deployment-id": "99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
        "bcx-created": "user1@buttonwood.int on 2018-08-07 10:42:05 +1000"
      },
      "runtimeProperties": {
        "privateIpAddress": "172.31.99.99",
        "publicIpAddress": "54.66.66.66",
        "state": "running",
        "stateReason": null,
        "architecture": "x86_64",
        "instanceType": "t2.medium",
        "publicDnsName": "ec2-54-66-160-248.ap-southeast-2.compute.amazonaws.com",
        "privateDnsName": "ip-172-31-3-37.ap-southeast-2.compute.internal",
        "imageId": "ami-ba3e14d9",
        "subnetId": "subnet-12345601",
        "volumes": [
          {
            "volumeId": "vol-0dab55a99f1735c1c",
            "device": "/dev/sda1",
            "size": 20,
            "iops": 100,
            "state": "in-use",
            "encrypted": false,
            "volumeType": "gp2"
          }
        ],
        "display_properties": [
          {
            "type": "string",
            "name": "Public IP",
            "value": "54.66.66.66"
          },
          {
            "type": "string",
            "name": "Private IP",
            "value": "172.31.99.99"
          },
          {
            "type": "string",
            "name": "Public DNS name",
            "value": "ec2-54-66-66-66.ap-southeast-2.compute.amazonaws.com"
          },
          {
            "type": "string",
            "name": "Private DNS name",
            "value": "ip-172-31-99-99.ap-southeast-2.compute.internal"
          },
          {
            "type": "string",
            "name": "Instance type",
            "value": "t2.medium"
          },
          {
            "type": "string",
            "name": "State",
            "value": "running"
          },
          {
            "type": "string",
            "name": "Volumes",
            "value": "vol-0dab55a99f1735c1c  /dev/sda1  20.0 GiB (100 IOPS)"
          },
          {
            "type": "string",
            "name": "Image ID",
            "value": "ami-ba3e14d9"
          }
        ]
      }
    }
  ]
}

POST /api/v1/deployment 

Starts a provisioning task of a catalog item.

Parameters

Parameter Data Type Description
catalogItemId int Catalog Item ID
leaseEndDate
or
leaseDurationDays		 date [YYYY-MM-DD]

int		 Lease end date or duration in days of the lease
costCentreId
or
costCentreName		 int

string		 Cost Centre ID or Cost Centre name
classificationId
or
classificationName		 int

string		 Optional
Classification ID or Classification Name
Required if Classifications policy is active for the Environment
name string Name for the deployment
Must be unique across all active deployments
description string Optional
Description for the deployment

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    --header 
"Content-Type: application/json" -X POST -d '{"catalogItemId": 321955, "leaseEndDate": 2018-08-07", "name": "My First Blueprint 03", "costCentreId": 41}' \
    https://broker.buttonwood.int/api/v1/deployment

Example Response

{
  "deployment": {
    "id": "99cc6c7b-bfc8-4c5b-a900-b37c4e3cd0a0",
    "name": "My First Blueprint 03",
    "description": null,
    "blueprintId": 76427,
    "hoursOfOperationMode": "CompleteSchedule",
    "blueprintName": "Single Micro g",
    "state": "Creating",
    "stateExplanation": null,
    "provisioningState": "Creating",
    "nativeCloudNetworkId": 324,
    "environmentName": "Test",
    "owner": "user1@buttonwood.int",
    "costCentreId": "41",
    "leaseStartDate": "2018-08-06T14:12:32+1100",
    "leaseEndDate": "2018-08-07T23:59:59+1100",
    "endOfLeaseAction": "Disable",
    "createdOn": "2018-08-06T14:12:33+1100",
    "createdBy": "user1@buttonwood.int",
    "modifiedOn": "2018-08-06T14:14:46+1100",
    "modifiedBy": "user1@buttonwood.int",
    "url": ""
  }
}

POST /api/v1/deployment/{externalId}/powerState

Powers on or off a deployment.

Parameters

Parameter Data Type Description
powerState string

start
Executes the deployment power on sequence

stop
Executes the deployment power off sequence

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    --header 
"Content-Type: application/json" -X POST -d '{"powerState" : "stop"}' \
    https://broker.buttonwood.int/api/v1/deployment/c21e2ad8-af03-4388-9c86-faaf3551ddda/powerState

Example Response

{"jobId":"77449386-41eb-4f9e-921d-a951def16db1","state":"Pending"}

DELETE /api/v1/deployment/{externalId}

Starts a termination task for a deployment.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    --header 
"Content-Type: application/json" -X DELETE \
    https://broker.buttonwood.int/api/v1/deployment/c21e2ad8-af03-4388-9c86-faaf3551ddda

Example Response

{"jobId":"94e68f83-b2fb-4181-ab43-fd537413dbd2","state":"Pending"}

GET /api/v1/job/{jobId}

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/job/94e68f83-b2fb-4181-ab43-fd537413dbd2

Example Response

{
  "job": {
    "uuid": "a6816a0a-4dc9-49d9-9c95-3e158e65193c",
    "id": 2191090,
    "name": "Power Off 'My First Blueprint 01'",
    "state": "Failed",
    "owner": "user1@buttonwood.int",
    "timeoutInMinutes": 1440,
    "currentSequenceNumber": 0,
    "description": "Power off all the machines in the deployment, in reverse start group order",
    "startTime": "2018-08-06T09:38:15+1100",
    "endTime": "2018-08-06T09:38:23+1100",
    "message": "Job failed because one of its tasks failed or was cancelled.",
    "jobData": "{}",
    "jobType": "net.buttonwood.bcxbroker.job.PowerOffDeploymentJob",
    "tasks": [
      {
        "id": 2191099,
        "uuid": "80ff07cf-be31-4beb-b141-8c0e96eb6616",
        "name": "Set state to Stopped for deployment 92",
        "sequenceNumber": 2,
        "state": "Pending",
        "message": null,
        "startTime": "",
        "endTime": "",
        "type": "net.buttonwood.bcxbroker.job.UpdateDeploymentStateTask",
        "cancellable": false,
        "cancelledOn": "",
        "cancelledBy": null
      },
      {
        "id": 2191093,
        "uuid": "8ac6525c-8a9b-4f1f-89d0-e7f502fe01fd",
        "name": "Set state to Stopping for deployment 92",
        "sequenceNumber": 0,
        "state": "Completed",
        "message": "Running",
        "startTime": "2018-08-06T09:38:18+1100",
        "endTime": "2018-08-06T09:38:22+1100",
        "type": "net.buttonwood.bcxbroker.job.UpdateDeploymentStateTask",
        "cancellable": false,
        "cancelledOn": "",
        "cancelledBy": null
      },
      {
        "id": 2191096,
        "uuid": "ae52360e-3920-4e87-b0a0-f2549d04a23b",
        "name": "Powering off Cloud VM 2176671",
        "sequenceNumber": 1,
        "state": "Failed",
        "message": "Could not retrieve instance details for instance id 'i-0af97106fed13473b'",
        "startTime": "2018-08-06T09:38:22+1100",
        "endTime": "2018-08-06T09:38:23+1100",
        "type": "net.buttonwood.bcxbroker.job.PowerOffCloudVMTask",
        "cancellable": false,
        "cancelledOn": "",
        "cancelledBy": null
      }
    ],
    "cancelled": false
  }
}

GET /api/v1/version

Returns version information about the Broker.

curl Example

curl –insecure --header "Authorization: Bearer ZDY3MTabcDeFGhiJkLmnOpqrstUVWxYzAbcdEFGHIJklMnOp" \
    https://broker.buttonwood.int/api/v1/version

Example Response

{
  "version": {
    "brokerApiVersion": "2.5.35",
    "brokerSID": "367a6d30-0123-4567-89ab-1a2b3c4d5e6f",
    "buildNumber": "559",
    "codeName": "Huracán",
    "fullVersion": "Buttonwood Broker 2.5.0 'Huracán' (build 559) API Version: 2.5.35 SID: 367a6d30-0123-4567-89ab-1a2b3c4d5e6f GrailEnv: PRODUCTION",
    "grailsEnvironment": "PRODUCTION",
    "version": "2.5.0"
  }
}