API-referens

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Blueprint Catalog Sources

GET /boundaries/{boundaryId}/resources/blueprints/sources

Repositories this boundary publishes its own blueprints from

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/blueprints/sources

Register a repository as a private blueprint catalog source

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Begärans innehåll: CreateCatalogSourceRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}

Remove a catalog source and the blueprints it published

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
sourceId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}

Change a catalog source's branch or path, or pause it

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
sourceId	sökväg	uuid	Ja

Begärans innehåll: UpdateCatalogSourceRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/blueprints/sources/{sourceId}/sync

Pull a catalog source now

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
sourceId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

Blueprint Templates

POST /boundaries/{boundaryId}/resources/blueprints/templates

Create or replace a boundary-scoped blueprint template

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Begärans innehåll: TemplateContent

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/blueprints/templates/validate

Validate a template document without storing it

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Begärans innehåll: TemplateContent

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resources/blueprints/templates/{slug}

Delete a boundary-scoped blueprint template

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
slug	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

Blueprints

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/blueprints/{slug}/deploy

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
slug	sökväg	string	Ja
dryRun	frågesträng	boolean	Nej

Begärans innehåll: DeployBlueprintRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/blueprints/catalog/refresh

Pull the blueprint catalog from its source now

• Autentisering: krävs
• IAM-åtgärd: blueprints/templates/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/templates/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/catalog/status

Where the built-in catalog is pulled from, and when it last synced

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/config

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/deploys

Recent template deploys in this boundary, newest first

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	frågesträng	string	Nej
take	frågesträng	integer	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/deploys/{executionId}

One template deploy and its outcome

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
executionId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/blueprints/deploys/{executionId}/retry

Queue a failed deploy again, as a new execution

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
executionId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/{blueprintId}

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
blueprintId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/blueprints/{slug}

• Autentisering: krävs
• IAM-åtgärd: blueprints/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
slug	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte blueprints/read på det utvärderade omfånget

Docs

GET /docs/blueprints/manifest.json

• Autentisering: krävs
• Operationsnamn: DocsManifest_blueprints

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

GET /docs/blueprints/{path}

• Autentisering: krävs
• Operationsnamn: DocsFile_blueprints

Parametrar

Namn	Plats	Typ	Obligatorisk
path	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

Övriga slutpunkter

GET /readyz

• Autentisering: ingen — anonyma anrop accepteras
• Operationsnamn: StackshipReadiness

Svar

Status	Betydelse	Innehåll

Scheman

CreateCatalogSourceRequest

Egenskap	Typ	Kan vara null
installationId	string	Ja
path	string	Ja
provider	string	Ja
ref	string	Ja
repositoryFullName	string	Ja
repositoryId	string	Ja
repositoryUrl	string	Ja

DeployBlueprintRequest

Egenskap	Typ	Kan vara null
blueprintId	uuid	Nej
clusterId	uuid	Nej
componentOverrides	DeployComponentOverride []	Ja
name	string	Nej
parameters	map (string)	Nej

DeployComponentOverride

Egenskap	Typ	Kan vara null
computePlan	string	Ja
name	string	Nej
replicas	integer	Ja

TemplateContent

Egenskap	Typ	Kan vara null
content	string	Nej

UpdateCatalogSourceRequest

Egenskap	Typ	Kan vara null
enabled	boolean	Ja
path	string	Ja
ref	string	Ja