API-referens

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

Docs

GET /docs/functions/manifest.json

• Autentisering: krävs
• Operationsnamn: DocsManifest_functions

Svar

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

GET /docs/functions/{path}

• Autentisering: krävs
• Operationsnamn: DocsFile_functions

Parametrar

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

Svar

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

Function Source

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/source

Deletes stored source after the controller has consumed it.

• Autentisering: krävs
• Operationsnamn: DeleteFunctionSource

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/source

Returns the stored source zip for a function.

• Autentisering: krävs
• Operationsnamn: GetFunctionSource

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/source

Uploads function source code. The backend zips it before storing.

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Begärans innehåll: UploadSourceRequest

Svar

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

FunctionComputePlans

GET /boundaries/{boundaryId}/resources/functioncomputeplans

• Autentisering: krävs
• IAM-åtgärd: functions/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 functions/read på det utvärderade omfånget

FunctionNamespaces

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces

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

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/config

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

Parametrar

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

Svar

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

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}

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

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}

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

Parametrar

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

Svar

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

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}

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

Parametrar

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

Begärans innehåll: any

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}

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

Parametrar

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

Begärans innehåll: FunctionNamespaceDto

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}

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

Parametrar

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

Begärans innehåll: FunctionNamespaceDto

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/deployments

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

Parametrar

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

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/deployments

• Autentisering: krävs

Parametrar

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

Begärans innehåll: DeploymentLogEntryDto

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/deployments/{deploymentId}

• Autentisering: krävs

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
deploymentId	sökväg	uuid	Ja

Begärans innehåll: DeploymentLogEntryDto

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/deployments/{deploymentId}/logs

• Autentisering: krävs

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
deploymentId	sökväg	uuid	Ja

Begärans innehåll: UploadBuildLogsRequest

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions

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

Parametrar

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

Svar

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

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Begärans innehåll: FunctionDto

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Begärans innehåll: FunctionDto

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/logs

• Autentisering: krävs
• IAM-åtgärd: functions/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/metrics

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja
from	frågesträng	integer	Nej
step	frågesträng	string	Nej
stepSeconds	frågesträng	integer	Nej
to	frågesträng	integer	Nej

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/metrics/web

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/functions/{functionName}/scale

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

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
namespaceName	sökväg	string	Ja
functionName	sökväg	string	Ja

Begärans innehåll: ScaleRequest

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/functionnamespaces/{namespaceName}/logs

• Autentisering: krävs
• IAM-åtgärd: functions/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

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

Svar

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

GET /boundaries/{boundaryId}/resources/functionnamespaces

• Autentisering: krävs
• IAM-åtgärd: functions/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	PagedListResponse<FunctionNamespaceDto>
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte functions/read på det utvärderade omfånget

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

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

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 functions/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/functionnamespaces/url

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

Parametrar

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

Begärans innehåll: FunctionNamespaceNameRequest

Svar

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

FunctionRuntimes

GET /boundaries/{boundaryId}/resources/functionruntimes

• Autentisering: krävs
• IAM-åtgärd: functions/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 functions/read på det utvärderade omfånget

Övriga slutpunkter

GET /readyz

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

Svar

Status	Betydelse	Innehåll

Scheman

AuthConfigDto

Egenskap	Typ	Kan vara null
audience	string	Ja
enabled	boolean	Nej
issuer	string	Ja

DeploymentLogEntryDto

Egenskap	Typ	Kan vara null
boundaryId	uuid	Nej
deploymentId	uuid	Nej
functionName	string	Ja
id	uuid	Nej
lastMessage	string	Nej
namespaceName	string	Nej
phase	string	Nej
resourceGroupName	string	Nej
source	string	Ja
timestamp	date-time	Nej

FunctionDto

Egenskap	Typ	Kan vara null
auth	AuthConfigDto	Ja
clusterId	uuid	Nej
clusterName	string	Nej
computePlan	string	Nej
createdAt	date-time	Nej
endpoint	string	Nej
entrypoint	string	Ja
environment	map (string)	Ja
id	uuid	Nej
image	string	Ja
name	string	Nej
namespaceName	string	Nej
phase	string	Nej
replicas	integer	Nej
resources	ResourceConfigDto	Ja
runtime	string	Nej
scaling	ScalingConfigDto	Ja
secrets	map (string)	Ja
source	string	Ja
sourceCode	string	Ja
trigger	TriggerDto	Ja

FunctionNamespaceDto

Egenskap	Typ	Kan vara null
boundary	string	Nej
boundaryId	uuid	Nej
clusterId	uuid	Nej
clusterName	string	Nej
collection	string	Nej
createdAt	date-time	Nej
defaultAuth	AuthConfigDto	Ja
defaultResources	ResourceConfigDto	Ja
defaultScaling	ScalingConfigDto	Ja
environment	map (string)	Ja
functionCount	integer	Nej
functions	FunctionSummaryDto []	Nej
host	string	Nej
id	uuid	Nej
name	string	Nej
readyFunctions	integer	Nej
region	string	Nej
resourceGroup	string	Nej
status	string	Nej
tags	map (string)	Nej
tls	TlsDto	Ja

FunctionNamespaceNameRequest

Egenskap	Typ	Kan vara null
name	string	Nej

FunctionSummaryDto

Egenskap	Typ	Kan vara null
endpoint	string	Nej
name	string	Nej
phase	string	Nej
replicas	integer	Nej
runtime	string	Nej
triggerType	string	Nej

PagedListResponse<FunctionDto>

Egenskap	Typ	Kan vara null
items	FunctionDto []	Nej
pagination	PaginationMeta	Nej

PagedListResponse<FunctionNamespaceDto>

Egenskap	Typ	Kan vara null
items	FunctionNamespaceDto []	Nej
pagination	PaginationMeta	Nej

PaginationMeta

Egenskap	Typ	Kan vara null
hasNextPage	boolean	Nej
hasPreviousPage	boolean	Nej
page	integer	Nej
pageSize	integer	Nej
totalItems	integer	Nej
totalPages	integer	Nej

ResourceConfigDto

Egenskap	Typ	Kan vara null
cpu	string	Nej
memory	string	Nej

ScaleRequest

Egenskap	Typ	Kan vara null
problem	string	Ja
replicas	integer	Ja

ScalingConfigDto

Egenskap	Typ	Kan vara null
cooldownPeriod	integer	Nej
maxReplicas	integer	Nej
minReplicas	integer	Nej

TlsDto

Egenskap	Typ	Kan vara null
enabled	boolean	Nej
secretName	string	Ja

TriggerDto

Egenskap	Typ	Kan vara null
connection	string	Ja
httpRoute	string	Ja
methods	string []	Ja
queueName	string	Ja
schedule	string	Ja
type	string	Nej

UploadBuildLogsRequest

Egenskap	Typ	Kan vara null
boundaryId	string	Nej
functionName	string	Ja
logs	string	Nej
namespaceName	string	Nej
resourceGroupName	string	Nej
timestamp	date-time	Nej

UploadSourceRequest

Egenskap	Typ	Kan vara null
code	string	Nej
entrypoint	string	Ja