Spinnaker API

Amazoninfrastructurecontroller

instanceTypesUsingGET

instanceTypes


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

subnetsUsingGET

subnets


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

vpcsUsingGET

vpcs


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

Applicationcontroller

cancelPipelineUsingPUT

cancelPipeline


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
reason

cancelTaskUsingPUT

cancelTask


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

Parameters

Path parameters
Name Description
id*

getAllApplicationsUsingGET

Retrieve a list of applications


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

getApplicationHistoryUsingGET

Retrieve a list of an application's configuration revision history


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

Parameters

Path parameters
Name Description
application*
Query parameters
Name Description
limit

getApplicationUsingGET

Retrieve an application's details


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

Parameters

Path parameters
Name Description
application*
Query parameters
Name Description
expand

getPipelineConfigUsingGET

Retrieve a pipeline configuration


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

Parameters

Path parameters
Name Description
application*
pipelineName*

getPipelineConfigsForApplicationUsingGET

Retrieve a list of an application's pipeline configurations


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

Parameters

Path parameters
Name Description
application*

getPipelinesUsingGET

Retrieve a list of an application's pipeline executions


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

Parameters

Path parameters
Name Description
application*
Query parameters
Name Description
limit
statuses

getStrategyConfigUsingGET

Retrieve a pipeline strategy configuration


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

Parameters

Path parameters
Name Description
application*
strategyName*

getStrategyConfigsForApplicationUsingGET

Retrieve a list of an application's pipeline strategy configurations


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

Parameters

Path parameters
Name Description
application*

getTaskDetailsUsingGET

getTaskDetails


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

Parameters

Path parameters
Name Description
id*
taskDetailsId*

getTaskUsingGET

getTask


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

Parameters

Path parameters
Name Description
id*

getTasksUsingGET

Retrieve a list of an application's tasks


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

Parameters

Path parameters
Name Description
application*
Query parameters
Name Description
limit
statuses

invokePipelineConfigUsingPOST

invokePipelineConfig


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

Parameters

Path parameters
Name Description
application*
pipelineName*
Body parameters
Name Description
trigger
Query parameters
Name Description
user

taskUsingPOST

task


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

Parameters

Path parameters
Name Description
application*
Body parameters
Name Description
map *

Authcontroller

getServiceAccountsUsingGET

getServiceAccounts


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

loggedOutUsingGET

loggedOut


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

redirectUsingGET

redirect


/auth/redirect
curl -X get "https://localhost:8084//auth/redirect?to="
Query parameters
Name Description
to*

syncUsingPOST

sync


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

userUsingGET

user


/auth/user
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 -X get "https://localhost:8084//bakery/options/{cloudProvider}"

Parameters

Path parameters
Name Description
cloudProvider*

bakeOptionsUsingGET1

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


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

lookupLogsUsingGET

Retrieve the logs for a given bake


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

Parameters

Path parameters
Name Description
region*
statusId*

Buildcontroller

getBuildMastersUsingGET

getBuildMasters


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

getBuildUsingGET

getBuild


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

Parameters

Path parameters
Name Description
buildMaster*
number*

getBuildsUsingGET

getBuilds


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

Parameters

Path parameters
Name Description
buildMaster*

getJobConfigUsingGET

getJobConfig


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

Parameters

Path parameters
Name Description
buildMaster*

getJobsForBuildMasterUsingGET

getJobsForBuildMaster


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

Parameters

Path parameters
Name Description
buildMaster*

Clustercontroller

getClusterLoadBalancersUsingGET

getClusterLoadBalancers


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

Parameters

Path parameters
Name Description
applicationName*
account*
clusterName*
type*

getClustersUsingGET

Retrieve a cluster's details


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

Parameters

Path parameters
Name Description
application*
account*
clusterName*

getClustersUsingGET1

Retrieve a list of clusters for an account


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

Parameters

Path parameters
Name Description
application*
account*

getClustersUsingGET2

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


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

Parameters

Path parameters
Name Description
application*

getScalingActivitiesUsingGET

Retrieve a list of scaling activities for a server group


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

Parameters

Path parameters
Name Description
application*
account*
clusterName*
serverGroupName*
Query parameters
Name Description
provider
region

getServerGroupsUsingGET

Retrieve a server group's details


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

Parameters

Path parameters
Name Description
application*
account*
clusterName*
serverGroupName*

getServerGroupsUsingGET1

Retrieve a list of server groups for a cluster


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

Parameters

Path parameters
Name Description
application*
account*
clusterName*

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 -X get "https://localhost:8084//applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}?onlyEnabled=&validateOldest="

Parameters

Path parameters
Name Description
application*
account*
clusterName*
cloudProvider*
scope*
target*
Query parameters
Name Description
onlyEnabled
validateOldest

Credentialscontroller

getAccountUsingGET

Retrieve an account's details


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

Parameters

Path parameters
Name Description
account*

getAccountsUsingGET

Retrieve a list of accounts


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

Executionscontroller

getActiveExecutionsByInstanceUsingGET

Retrieve a list of active executions, grouped by Orca instance


/executions/activeByInstance
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 -X get "https://localhost:8084//executions?pipelineConfigIds=&limit=&statuses="
Query parameters
Name Description
pipelineConfigIds*
limit
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 -X get "https://localhost:8084//images/find?provider=&q=®ion=&account=&count="
Query parameters
Name Description
provider
q
region
account
count

findTagsUsingGET

findTags


/images/tags
curl -X get "https://localhost:8084//images/tags?provider=&account=&repository="
Query parameters
Name Description
provider
account*
repository*

getImageDetailsUsingGET

getImageDetails


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

Parameters

Path parameters
Name Description
account*
region*
imageId*
Query parameters
Name Description
provider

Instancecontroller

getConsoleOutputUsingGET

Retrieve an instance's console output


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

Parameters

Path parameters
Name Description
account*
region*
instanceId*
Query parameters
Name Description
provider

getInstanceDetailsUsingGET

Retrieve an instance's details


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

Parameters

Path parameters
Name Description
account*
region*
instanceId*

Jobcontroller

getJobUsingGET

getJob


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

Parameters

Path parameters
Name Description
applicationName*
account*
region*
name*
Query parameters
Name Description
expand

getJobsUsingGET

getJobs


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

Parameters

Path parameters
Name Description
applicationName*
Query parameters
Name Description
expand

Loadbalancercontroller

getAllUsingGET

Retrieve a list of load balancers for a given cloud provider


/loadBalancers
curl -X get "https://localhost:8084//loadBalancers?provider="
Query parameters
Name Description
provider

getApplicationLoadBalancersUsingGET

Retrieve a list of load balancers for a given application


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

Parameters

Path parameters
Name Description
application*

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 -X get "https://localhost:8084//loadBalancers/{account}/{region}/{name}?provider="

Parameters

Path parameters
Name Description
account*
region*
name*
Query parameters
Name Description
provider

getLoadBalancerUsingGET

Retrieve a load balancer for a given cloud provider


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

Parameters

Path parameters
Name Description
name*
Query parameters
Name Description
provider

Networkcontroller

allByCloudProviderUsingGET

Retrieve a list of networks for a given cloud provider


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

Parameters

Path parameters
Name Description
cloudProvider*

allUsingGET

Retrieve a list of networks, grouped by cloud provider


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

Pipelinecontroller

cancelPipelineUsingPUT1

Cancel a pipeline execution


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
reason
force

deletePipelineUsingDELETE

Delete a pipeline definition


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

Parameters

Path parameters
Name Description
application*
pipelineName*

deletePipelineUsingDELETE1

Delete a pipeline execution


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

Parameters

Path parameters
Name Description
id*

evaluateExpressionForExecutionUsingDELETE

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingGET

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingHEAD

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingOPTIONS

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingPATCH

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingPOST

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

evaluateExpressionForExecutionUsingPUT

Evaluate a pipeline expression using the provided execution as context


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
expression*

getPipelineLogsUsingGET

Retrieve pipeline execution logs


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

Parameters

Path parameters
Name Description
id*

getPipelineUsingGET

Retrieve a pipeline execution


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

Parameters

Path parameters
Name Description
id*

invokePipelineConfigUsingPOST1

Trigger a pipeline execution


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

Parameters

Path parameters
Name Description
application*
pipelineNameOrId*
Body parameters
Name Description
trigger

pausePipelineUsingPUT

Pause a pipeline execution


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

Parameters

Path parameters
Name Description
id*

renamePipelineUsingPOST

Rename a pipeline definition


/pipelines/move
curl -X post "https://localhost:8084//pipelines/move"
Body parameters
Name Description
renameCommand *

restartStageUsingPUT

Restart a stage execution


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

Parameters

Path parameters
Name Description
id*
stageId*
Body parameters
Name Description
context *

resumePipelineUsingPUT

Resume a pipeline execution


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

Parameters

Path parameters
Name Description
id*

savePipelineUsingPOST

Save a pipeline definition


/pipelines
curl -X post "https://localhost:8084//pipelines"
Body parameters
Name Description
pipeline *

startUsingPOST

Initiate a pipeline execution


/pipelines/start
curl -X post "https://localhost:8084//pipelines/start"
Body parameters
Name Description
map *

updatePipelineUsingPUT

Update a pipeline definition


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

Parameters

Path parameters
Name Description
id*
Body parameters
Name Description
pipeline *

updateStageUsingPATCH

Update a stage execution


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

Parameters

Path parameters
Name Description
id*
stageId*
Body parameters
Name Description
context *

Projectcontroller

allPipelinesForProjectUsingGET

allPipelinesForProject


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

Parameters

Path parameters
Name Description
id*
Query parameters
Name Description
limit
statuses

Searchcontroller

searchUsingGET

search


/search
curl -X get "https://localhost:8084//search?q=&type=&platform=&pageSize=&page="
Query parameters
Name Description
q*
type*
platform
pageSize
page

Securitygroupcontroller

allByAccountUsingGET

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


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

Parameters

Path parameters
Name Description
account*
Query parameters
Name Description
provider
region

allUsingGET1

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


/securityGroups
curl -X get "https://localhost:8084//securityGroups?id="
Query parameters
Name Description
id

getSecurityGroupUsingGET

Retrieve a security group's details


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

Parameters

Path parameters
Name Description
account*
region*
name*
Query parameters
Name Description
provider
vpcId

Servergroupcontroller

getServerGroupDetailsUsingGET

Retrieve a server group's details


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

Parameters

Path parameters
Name Description
applicationName*
account*
region*
serverGroupName*

getServerGroupsUsingGET2

Retrieve a list of server groups for a given application


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

Parameters

Path parameters
Name Description
applicationName*
Query parameters
Name Description
expand
cloudProvider
clusters

Snapshotcontroller

getCurrentSnapshotUsingGET

getCurrentSnapshot


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

Parameters

Path parameters
Name Description
application*
account*

getSnapshotHistoryUsingGET

getSnapshotHistory


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

Parameters

Path parameters
Name Description
application*
account*
Query parameters
Name Description
limit

Subnetcontroller

allByCloudProviderUsingGET1

Retrieve a list of subnets for a given cloud provider


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

Parameters

Path parameters
Name Description
cloudProvider*

Taskcontroller

cancelTaskUsingPUT1

cancelTask


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

Parameters

Path parameters
Name Description
id*

cancelTasksUsingPUT

cancelTasks


/tasks/cancel
curl -X put "https://localhost:8084//tasks/cancel?ids="
Query parameters
Name Description
ids*

deleteTaskUsingDELETE

deleteTask


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

Parameters

Path parameters
Name Description
id*

getTaskDetailsUsingGET1

getTaskDetails


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

Parameters

Path parameters
Name Description
id*
taskDetailsId*

getTaskUsingGET1

getTask


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

Parameters

Path parameters
Name Description
id*

taskUsingPOST1

task


/tasks
curl -X post "https://localhost:8084//tasks"
Body parameters
Name Description
map *
Generated 2017-06-07T15:07:49.004-04:00