Spinnaker API

Amazoninfrastructurecontroller

instanceTypesUsingGET

instanceTypes

/instanceTypes

Curl

curl -X get "https://localhost:8084//instanceTypes"

subnetsUsingGET

subnets

/subnets

Curl

curl -X get "https://localhost:8084//subnets"

vpcsUsingGET

vpcs

/vpcs

Curl

curl -X get "https://localhost:8084//vpcs"

Applicationcontroller

cancelPipelineUsingPUT

cancelPipeline

/applications/{application}/pipelines/{id}/cancel

Curl

curl -X put "https://localhost:8084//applications/{application}/pipelines/{id}/cancel?reason="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
reason	string reason

cancelTaskUsingPUT

cancelTask

/applications/{application}/tasks/{id}/cancel

Curl

curl -X put "https://localhost:8084//applications/{application}/tasks/{id}/cancel"

Parameters

Path parameters

Name	Description
id*	string id Required

getAllApplicationsUsingGET

Retrieve a list of applications

/applications

Curl

curl -X get "https://localhost:8084//applications"

getApplicationHistoryUsingGET

Retrieve a list of an application's configuration revision history

/applications/{application}/history

Curl

curl -X get "https://localhost:8084//applications/{application}/history?limit="

Parameters

Path parameters

Name	Description
application*	string application Required

Query parameters

Name	Description
limit	integer (int32) limit Default: 20

getApplicationUsingGET

Retrieve an application's details

/applications/{application}

Curl

curl -X get "https://localhost:8084//applications/{application}?expand="

Parameters

Path parameters

Name	Description
application*	string application Required

Query parameters

Name	Description
expand	boolean expand Default: true

getPipelineConfigUsingGET

Retrieve a pipeline configuration

/applications/{application}/pipelineConfigs/{pipelineName}

Curl

curl -X get "https://localhost:8084//applications/{application}/pipelineConfigs/{pipelineName}"

Parameters

Path parameters

Name	Description
application*	string application Required
pipelineName*	string pipelineName Required

getPipelineConfigsForApplicationUsingGET

Retrieve a list of an application's pipeline configurations

/applications/{application}/pipelineConfigs

Curl

curl -X get "https://localhost:8084//applications/{application}/pipelineConfigs"

Parameters

Path parameters

Name	Description
application*	string application Required

getPipelinesUsingGET

Retrieve a list of an application's pipeline executions

/applications/{application}/pipelines

Curl

curl -X get "https://localhost:8084//applications/{application}/pipelines?limit=&statuses="

Parameters

Path parameters

Name	Description
application*	string application Required

Query parameters

Name	Description
limit	integer (int32) limit
statuses	string statuses

getStrategyConfigUsingGET

Retrieve a pipeline strategy configuration

/applications/{application}/strategyConfigs/{strategyName}

Curl

curl -X get "https://localhost:8084//applications/{application}/strategyConfigs/{strategyName}"

Parameters

Path parameters

Name	Description
application*	string application Required
strategyName*	string strategyName Required

getStrategyConfigsForApplicationUsingGET

Retrieve a list of an application's pipeline strategy configurations

/applications/{application}/strategyConfigs

Curl

curl -X get "https://localhost:8084//applications/{application}/strategyConfigs"

Parameters

Path parameters

Name	Description
application*	string application Required

getTaskDetailsUsingGET

getTaskDetails

/applications/{application}/tasks/{id}/details/{taskDetailsId}

Curl

curl -X get "https://localhost:8084//applications/{application}/tasks/{id}/details/{taskDetailsId}"

Parameters

Path parameters

Name	Description
id*	string id Required
taskDetailsId*	string taskDetailsId Required

getTaskUsingGET

getTask

/applications/{application}/tasks/{id}

Curl

curl -X get "https://localhost:8084//applications/{application}/tasks/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

getTasksUsingGET

Retrieve a list of an application's tasks

/applications/{application}/tasks

Curl

curl -X get "https://localhost:8084//applications/{application}/tasks?limit=&statuses="

Parameters

Path parameters

Name	Description
application*	string application Required

Query parameters

Name	Description
limit	integer (int32) limit
statuses	string statuses

invokePipelineConfigUsingPOST

invokePipelineConfig

/applications/{application}/pipelineConfigs/{pipelineName}

Curl

curl -X post "https://localhost:8084//applications/{application}/pipelineConfigs/{pipelineName}?user="

Parameters

Path parameters

Name	Description
application*	string application Required
pipelineName*	string pipelineName Required

Body parameters

Name	Description
trigger	{

Query parameters

Name	Description
user	string user

taskUsingPOST

task

/applications/{application}/tasks

Curl

curl -X post "https://localhost:8084//applications/{application}/tasks"

Parameters

Path parameters

Name	Description
application*	string application Required

Body parameters

Name	Description
map *	{

Authcontroller

getServiceAccountsUsingGET

getServiceAccounts

/auth/user/serviceAccounts

Curl

curl -X get "https://localhost:8084//auth/user/serviceAccounts"

loggedOutUsingGET

loggedOut

/auth/loggedOut

Curl

curl -X get "https://localhost:8084//auth/loggedOut"

redirectUsingGET

redirect

/auth/redirect

Curl

curl -X get "https://localhost:8084//auth/redirect?to="

Query parameters

Name	Description
to*	string to Required

syncUsingPOST

sync

/auth/roles/sync

Curl

curl -X post "https://localhost:8084//auth/roles/sync"

userUsingGET

user

/auth/user

Curl

curl -X get "https://localhost:8084//auth/user"

Bakecontroller

bakeOptionsUsingGET

Retrieve a list of available bakery base images for a given cloud provider

/bakery/options/{cloudProvider}

Curl

curl -X get "https://localhost:8084//bakery/options/{cloudProvider}"

Parameters

Path parameters

Name	Description
cloudProvider*	string cloudProvider Required

bakeOptionsUsingGET1

Retrieve a list of available bakery base images, grouped by cloud provider

/bakery/options

Curl

curl -X get "https://localhost:8084//bakery/options"

lookupLogsUsingGET

Retrieve the logs for a given bake

/bakery/logs/{region}/{statusId}

Curl

curl -X get "https://localhost:8084//bakery/logs/{region}/{statusId}"

Parameters

Path parameters

Name	Description
region*	string region Required
statusId*	string statusId Required

Buildcontroller

getBuildMastersUsingGET

getBuildMasters

/v2/builds

Curl

curl -X get "https://localhost:8084//v2/builds"

getBuildUsingGET

getBuild

/v2/builds/{buildMaster}/build/{number}/**

Curl

curl -X get "https://localhost:8084//v2/builds/{buildMaster}/build/{number}/**"

Parameters

Path parameters

Name	Description
buildMaster*	string buildMaster Required
number*	string number Required

getBuildsUsingGET

getBuilds

/v2/builds/{buildMaster}/builds/**

Curl

curl -X get "https://localhost:8084//v2/builds/{buildMaster}/builds/**"

Parameters

Path parameters

Name	Description
buildMaster*	string buildMaster Required

getJobConfigUsingGET

getJobConfig

/v2/builds/{buildMaster}/jobs/**

Curl

curl -X get "https://localhost:8084//v2/builds/{buildMaster}/jobs/**"

Parameters

Path parameters

Name	Description
buildMaster*	string buildMaster Required

getJobsForBuildMasterUsingGET

getJobsForBuildMaster

/v2/builds/{buildMaster}/jobs

Curl

curl -X get "https://localhost:8084//v2/builds/{buildMaster}/jobs"

Parameters

Path parameters

Name	Description
buildMaster*	string buildMaster Required

Clustercontroller

getClusterLoadBalancersUsingGET

getClusterLoadBalancers

/applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancers

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancers"

Parameters

Path parameters

Name	Description
applicationName*	string applicationName Required
account*	string account name Required
clusterName*	string clusterName Required
type*	string type Required

getClustersUsingGET

Retrieve a cluster's details

/applications/{application}/clusters/{account}/{clusterName}

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}"

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account name Required
clusterName*	string clusterName Required

getClustersUsingGET1

Retrieve a list of clusters for an account

/applications/{application}/clusters/{account}

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}"

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account name Required

getClustersUsingGET2

Retrieve a list of cluster names for an application, grouped by account

/applications/{application}/clusters

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters"

Parameters

Path parameters

Name	Description
application*	string application Required

getScalingActivitiesUsingGET

Retrieve a list of scaling activities for a server group

/applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivities

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivities?provider=®ion="

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required
clusterName*	string clusterName Required
serverGroupName*	string serverGroupName Required

Query parameters

Name	Description
provider	string provider Default: aws
region	string region

getServerGroupsUsingGET

Retrieve a server group's details

/applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}"

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required
clusterName*	string clusterName Required
serverGroupName*	string serverGroupName Required

getServerGroupsUsingGET1

Retrieve a list of server groups for a cluster

/applications/{application}/clusters/{account}/{clusterName}/serverGroups

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/serverGroups"

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required
clusterName*	string clusterName Required

getTargetServerGroupUsingGET

Retrieve a server group that matches a target coordinate (e.g., newest, ancestor) relative to a cluster

scope is either a zone or a region

/applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}

Curl

curl -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}?onlyEnabled=&validateOldest="

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required
clusterName*	string clusterName Required
cloudProvider*	string cloudProvider Required
scope*	string scope Required
target*	string target Required

Query parameters

Name	Description
onlyEnabled	boolean onlyEnabled
validateOldest	boolean validateOldest

Credentialscontroller

getAccountUsingGET

Retrieve an account's details

/credentials/{account}

Curl

curl -X get "https://localhost:8084//credentials/{account}"

Parameters

Path parameters

Name	Description
account*	string account Required

getAccountsUsingGET

Retrieve a list of accounts

/credentials

Curl

curl -X get "https://localhost:8084//credentials?roles=&allowedAccounts=&email=&username=&firstName=&lastName="

Query parameters

Name	Description
roles	[ string ]
allowedAccounts	[ string ]
email	string
username	string
firstName	string
lastName	string

Executionscontroller

getActiveExecutionsByInstanceUsingGET

Retrieve a list of active executions, grouped by Orca instance

/executions/activeByInstance

Curl

curl -X get "https://localhost:8084//executions/activeByInstance"

getLatestExecutionsByConfigIdsUsingGET

Retrieve a list of the most recent pipeline executions for the provided `pipelineConfigIds` that match the provided `statuses` query parameter

/executions

Curl

curl -X get "https://localhost:8084//executions?pipelineConfigIds=&limit=&statuses="

Query parameters

Name	Description
pipelineConfigIds*	string pipelineConfigIds Required
limit	integer (int32) limit
statuses	string statuses

Imagecontroller

findImagesUsingGET

Retrieve a list of images, filtered by cloud provider, region, and account

The query parameter q filters the list of images by image name

/images/find

Curl

curl -X get "https://localhost:8084//images/find?provider=&q=®ion=&account=&count="

Query parameters

Name	Description
provider	string provider Default: aws
q	string q
region	string region
account	string account
count	integer (int32) count

findTagsUsingGET

findTags

/images/tags

Curl

curl -X get "https://localhost:8084//images/tags?provider=&account=&repository="

Query parameters

Name	Description
provider	string provider Default: aws
account*	string account Required
repository*	string repository Required

getImageDetailsUsingGET

getImageDetails

/images/{account}/{region}/{imageId}

Curl

curl -X get "https://localhost:8084//images/{account}/{region}/{imageId}?provider="

Parameters

Path parameters

Name	Description
account*	string account Required
region*	string region Required
imageId*	string imageId Required

Query parameters

Name	Description
provider	string provider Default: aws

Instancecontroller

getConsoleOutputUsingGET

Retrieve an instance's console output

/instances/{account}/{region}/{instanceId}/console

Curl

curl -X get "https://localhost:8084//instances/{account}/{region}/{instanceId}/console?provider="

Parameters

Path parameters

Name	Description
account*	string account Required
region*	string region Required
instanceId*	string instanceId Required

Query parameters

Name	Description
provider	string provider Default: aws

getInstanceDetailsUsingGET

Retrieve an instance's details

/instances/{account}/{region}/{instanceId}

Curl

curl -X get "https://localhost:8084//instances/{account}/{region}/{instanceId}"

Parameters

Path parameters

Name	Description
account*	string account name Required
region*	string region Required
instanceId*	string instanceId Required

Jobcontroller

getJobUsingGET

getJob

/applications/{applicationName}/jobs/{account}/{region}/{name}

Curl

curl -X get "https://localhost:8084//applications/{applicationName}/jobs/{account}/{region}/{name}?expand="

Parameters

Path parameters

Name	Description
applicationName*	string applicationName Required
account*	string account Required
region*	string region Required
name*	string name Required

Query parameters

Name	Description
expand	string expand Default: false

getJobsUsingGET

getJobs

/applications/{applicationName}/jobs

Curl

curl -X get "https://localhost:8084//applications/{applicationName}/jobs?expand="

Parameters

Path parameters

Name	Description
applicationName*	string applicationName Required

Query parameters

Name	Description
expand	string expand Default: false

Loadbalancercontroller

getAllUsingGET

Retrieve a list of load balancers for a given cloud provider

/loadBalancers

Curl

curl -X get "https://localhost:8084//loadBalancers?provider="

Query parameters

Name	Description
provider	string provider Default: aws

getApplicationLoadBalancersUsingGET

Retrieve a list of load balancers for a given application

/applications/{application}/loadBalancers

Curl

curl -X get "https://localhost:8084//applications/{application}/loadBalancers"

Parameters

Path parameters

Name	Description
application*	string application Required

getLoadBalancerDetailsUsingGET

Retrieve a load balancer's details as a single element list for a given account, region, cloud provider and load balancer name

/loadBalancers/{account}/{region}/{name}

Curl

curl -X get "https://localhost:8084//loadBalancers/{account}/{region}/{name}?provider="

Parameters

Path parameters

Name	Description
account*	string account Required
region*	string region Required
name*	string name Required

Query parameters

Name	Description
provider	string provider Default: aws

getLoadBalancerUsingGET

Retrieve a load balancer for a given cloud provider

/loadBalancers/{name}

Curl

curl -X get "https://localhost:8084//loadBalancers/{name}?provider="

Parameters

Path parameters

Name	Description
name*	string name Required

Query parameters

Name	Description
provider	string provider Default: aws

Networkcontroller

allByCloudProviderUsingGET

Retrieve a list of networks for a given cloud provider

/networks/{cloudProvider}

Curl

curl -X get "https://localhost:8084//networks/{cloudProvider}"

Parameters

Path parameters

Name	Description
cloudProvider*	string cloudProvider Required

allUsingGET

Retrieve a list of networks, grouped by cloud provider

/networks

Curl

curl -X get "https://localhost:8084//networks"

Pipelinecontroller

cancelPipelineUsingPUT1

Cancel a pipeline execution

/pipelines/{id}/cancel

Curl

curl -X put "https://localhost:8084//pipelines/{id}/cancel?reason=&force="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
reason	string reason
force	boolean force

deletePipelineUsingDELETE

Delete a pipeline definition

/pipelines/{application}/{pipelineName}

Curl

curl -X delete "https://localhost:8084//pipelines/{application}/{pipelineName}"

Parameters

Path parameters

Name	Description
application*	string application Required
pipelineName*	string pipelineName Required

deletePipelineUsingDELETE1

Delete a pipeline execution

/pipelines/{id}

Curl

curl -X delete "https://localhost:8084//pipelines/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

evaluateExpressionForExecutionUsingDELETE

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X delete "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingGET

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X get "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingHEAD

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X head "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingOPTIONS

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X options "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingPATCH

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X patch "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingPOST

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X post "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

evaluateExpressionForExecutionUsingPUT

Evaluate a pipeline expression using the provided execution as context

/pipelines/{id}/evaluateExpression

Curl

curl -X put "https://localhost:8084//pipelines/{id}/evaluateExpression?expression="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
expression*	string expression Required

getPipelineLogsUsingGET

Retrieve pipeline execution logs

/pipelines/{id}/logs

Curl

curl -X get "https://localhost:8084//pipelines/{id}/logs"

Parameters

Path parameters

Name	Description
id*	string id Required

getPipelineUsingGET

Retrieve a pipeline execution

/pipelines/{id}

Curl

curl -X get "https://localhost:8084//pipelines/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

invokePipelineConfigUsingPOST1

Trigger a pipeline execution

/pipelines/{application}/{pipelineNameOrId}

Curl

curl -X post "https://localhost:8084//pipelines/{application}/{pipelineNameOrId}"

Parameters

Path parameters

Name	Description
application*	string application Required
pipelineNameOrId*	string pipelineNameOrId Required

Body parameters

Name	Description
trigger	{

pausePipelineUsingPUT

Pause a pipeline execution

/pipelines/{id}/pause

Curl

curl -X put "https://localhost:8084//pipelines/{id}/pause"

Parameters

Path parameters

Name	Description
id*	string id Required

renamePipelineUsingPOST

Rename a pipeline definition

/pipelines/move

Curl

curl -X post "https://localhost:8084//pipelines/move"

Body parameters

Name	Description
renameCommand *	{

restartStageUsingPUT

Restart a stage execution

/pipelines/{id}/stages/{stageId}/restart

Curl

curl -X put "https://localhost:8084//pipelines/{id}/stages/{stageId}/restart"

Parameters

Path parameters

Name	Description
id*	string id Required
stageId*	string stageId Required

Body parameters

Name	Description
context *	{

resumePipelineUsingPUT

Resume a pipeline execution

/pipelines/{id}/resume

Curl

curl -X put "https://localhost:8084//pipelines/{id}/resume"

Parameters

Path parameters

Name	Description
id*	string id Required

savePipelineUsingPOST

Save a pipeline definition

/pipelines

Curl

curl -X post "https://localhost:8084//pipelines"

Body parameters

Name	Description
pipeline *	{

startUsingPOST

Initiate a pipeline execution

/pipelines/start

Curl

curl -X post "https://localhost:8084//pipelines/start"

Body parameters

Name	Description
map *	{

updatePipelineUsingPUT

Update a pipeline definition

/pipelines/{id}

Curl

curl -X put "https://localhost:8084//pipelines/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

Body parameters

Name	Description
pipeline *	{

updateStageUsingPATCH

Update a stage execution

/pipelines/{id}/stages/{stageId}

Curl

curl -X patch "https://localhost:8084//pipelines/{id}/stages/{stageId}"

Parameters

Path parameters

Name	Description
id*	string id Required
stageId*	string stageId Required

Body parameters

Name	Description
context *	{

Projectcontroller

allPipelinesForProjectUsingGET

allPipelinesForProject

/projects/{id}/pipelines

Curl

curl -X get "https://localhost:8084//projects/{id}/pipelines?limit=&statuses="

Parameters

Path parameters

Name	Description
id*	string id Required

Query parameters

Name	Description
limit	integer (int32) limit Default: 5
statuses	string statuses

Searchcontroller

searchUsingGET

/search

Curl

curl -X get "https://localhost:8084//search?q=&type=&platform=&pageSize=&page="

Query parameters

Name	Description
q*	string q Required
type*	string type Required
platform	string platform
pageSize	integer (int32) pageSize Default: 10000
page	integer (int32) page Default: 1

Securitygroupcontroller

allByAccountUsingGET

Retrieve a list of security groups for a given account, grouped by region

/securityGroups/{account}

Curl

curl -X get "https://localhost:8084//securityGroups/{account}?provider=®ion="

Parameters

Path parameters

Name	Description
account*	string account Required

Query parameters

Name	Description
provider	string provider Default: aws
region	string region

allUsingGET1

Retrieve a list of security groups, grouped by account, cloud provider, and region

/securityGroups

Curl

curl -X get "https://localhost:8084//securityGroups?id="

Query parameters

Name	Description
id	string id

getSecurityGroupUsingGET

Retrieve a security group's details

/securityGroups/{account}/{region}/{name}

Curl

curl -X get "https://localhost:8084//securityGroups/{account}/{region}/{name}?provider=&vpcId="

Parameters

Path parameters

Name	Description
account*	string account Required
region*	string region Required
name*	string name Required

Query parameters

Name	Description
provider	string provider Default: aws
vpcId	string vpcId

Servergroupcontroller

getServerGroupDetailsUsingGET

Retrieve a server group's details

/applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName}

Curl

curl -X get "https://localhost:8084//applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName}"

Parameters

Path parameters

Name	Description
applicationName*	string applicationName Required
account*	string account Required
region*	string region Required
serverGroupName*	string serverGroupName Required

getServerGroupsUsingGET2

Retrieve a list of server groups for a given application

/applications/{applicationName}/serverGroups

Curl

curl -X get "https://localhost:8084//applications/{applicationName}/serverGroups?expand=&cloudProvider=&clusters="

Parameters

Path parameters

Name	Description
applicationName*	string applicationName Required

Query parameters

Name	Description
expand	string expand Default: false
cloudProvider	string cloudProvider
clusters	string clusters

Snapshotcontroller

getCurrentSnapshotUsingGET

getCurrentSnapshot

/applications/{application}/snapshots/{account}

Curl

curl -X get "https://localhost:8084//applications/{application}/snapshots/{account}"

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required

getSnapshotHistoryUsingGET

getSnapshotHistory

/applications/{application}/snapshots/{account}/history

Curl

curl -X get "https://localhost:8084//applications/{application}/snapshots/{account}/history?limit="

Parameters

Path parameters

Name	Description
application*	string application Required
account*	string account Required

Query parameters

Name	Description
limit	integer (int32) limit Default: 20

Subnetcontroller

allByCloudProviderUsingGET1

Retrieve a list of subnets for a given cloud provider

/subnets/{cloudProvider}

Curl

curl -X get "https://localhost:8084//subnets/{cloudProvider}"

Parameters

Path parameters

Name	Description
cloudProvider*	string cloudProvider Required

Taskcontroller

cancelTaskUsingPUT1

cancelTask

/tasks/{id}/cancel

Curl

curl -X put "https://localhost:8084//tasks/{id}/cancel"

Parameters

Path parameters

Name	Description
id*	string id Required

cancelTasksUsingPUT

cancelTasks

/tasks/cancel

Curl

curl -X put "https://localhost:8084//tasks/cancel?ids="

Query parameters

Name	Description
ids*	[ ids string ]

deleteTaskUsingDELETE

deleteTask

/tasks/{id}

Curl

curl -X delete "https://localhost:8084//tasks/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

getTaskDetailsUsingGET1

getTaskDetails

/tasks/{id}/details/{taskDetailsId}

Curl

curl -X get "https://localhost:8084//tasks/{id}/details/{taskDetailsId}"

Parameters

Path parameters

Name	Description
id*	string id Required
taskDetailsId*	string taskDetailsId Required

getTaskUsingGET1

getTask

/tasks/{id}

Curl

curl -X get "https://localhost:8084//tasks/{id}"

Parameters

Path parameters

Name	Description
id*	string id Required

taskUsingPOST1

task

/tasks

Curl

curl -X post "https://localhost:8084//tasks"

Body parameters

Name	Description
map *	{

Generated 2017-06-07T15:07:49.004-04:00