API reference
Every HTTP endpoint of the blueprints module: authentication, IAM action, parameters, bodies and status codes.
Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.
Blueprint Catalog Sources
GET /boundaries/{boundaryId}/resources/blueprints/sources
Repositories this boundary publishes its own blueprints from
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
POST /boundaries/{boundaryId}/resources/blueprints/sources
Register a repository as a private blueprint catalog source
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Request body: CreateCatalogSourceRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
DELETE /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}
Remove a catalog source and the blueprints it published
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
sourceId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
PATCH /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}
Change a catalog source's branch or path, or pause it
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
sourceId |
path | uuid |
Yes |
Request body: UpdateCatalogSourceRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
POST /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}/sync
Pull a catalog source now
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
sourceId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
Blueprint Templates
POST /boundaries/{boundaryId}/resources/blueprints/templates
Create or replace a boundary-scoped blueprint template
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Request body: TemplateContent
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
POST /boundaries/{boundaryId}/resources/blueprints/templates/validate
Validate a template document without storing it
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Request body: TemplateContent
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
DELETE /boundaries/{boundaryId}/resources/blueprints/templates/{slug}
Delete a boundary-scoped blueprint template
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
slug |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
Blueprints
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/blueprints/{slug}/deploy
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
slug |
path | string |
Yes |
dryRun |
query | boolean |
No |
Request body: DeployBlueprintRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
POST /boundaries/{boundaryId}/resources/blueprints/catalog/refresh
Pull the blueprint catalog from its source now
- Authentication: required
- IAM action:
blueprints/templates/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/templates/write at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/catalog/status
Where the built-in catalog is pulled from, and when it last synced
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/config
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/deploys
Recent template deploys in this boundary, newest first
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
query | string |
No |
take |
query | integer |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/deploys/{executionId}
One template deploy and its outcome
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
executionId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
POST /boundaries/{boundaryId}/resources/blueprints/deploys/{executionId}/retry
Queue a failed deploy again, as a new execution
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
executionId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/{blueprintId}
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
blueprintId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/blueprints/{slug}
- Authentication: required
- IAM action:
blueprints/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
slug |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold blueprints/read at the evaluated scope |
Docs
GET /docs/blueprints/manifest.json
- Authentication: required
- Operation name:
DocsManifest_blueprints
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /docs/blueprints/{path}
- Authentication: required
- Operation name:
DocsFile_blueprints
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
Other endpoints
GET /readyz
- Authentication: none — anonymous callers are accepted
- Operation name:
StackshipReadiness
Responses
| Status | Meaning | Body |
|---|
Schemas
CreateCatalogSourceRequest
| Property | Type | Nullable |
|---|---|---|
installationId |
string |
Yes |
path |
string |
Yes |
provider |
string |
Yes |
ref |
string |
Yes |
repositoryFullName |
string |
Yes |
repositoryId |
string |
Yes |
repositoryUrl |
string |
Yes |
DeployBlueprintRequest
| Property | Type | Nullable |
|---|---|---|
blueprintId |
uuid |
No |
clusterId |
uuid |
No |
componentOverrides |
DeployComponentOverride [] |
Yes |
name |
string |
No |
parameters |
map (string) |
No |
DeployComponentOverride
| Property | Type | Nullable |
|---|---|---|
computePlan |
string |
Yes |
name |
string |
No |
replicas |
integer |
Yes |
TemplateContent
| Property | Type | Nullable |
|---|---|---|
content |
string |
No |
UpdateCatalogSourceRequest
| Property | Type | Nullable |
|---|---|---|
enabled |
boolean |
Yes |
path |
string |
Yes |
ref |
string |
Yes |