Hoppa till innehållet
Stackship-dokumentation English

App ServiceAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen apps: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.

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

App Compute Plans

GET /boundaries/{boundaryId}/resources/appcomputeplans

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

App Files

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files

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

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja
component frågesträng string Nej
path frågesträng string Nej
recursive frågesträng boolean Nej

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files

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

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja
component frågesträng string Nej
path frågesträng string Nej

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files/archive

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

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja
component frågesträng string Nej
path frågesträng string Nej

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files/directory

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

Parametrar

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

Begärans innehåll: MakeDirectoryRequest

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files/download

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

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja
component frågesträng string Nej
path frågesträng string Nej

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files/move

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

Parametrar

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

Begärans innehåll: MoveRequest

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/apps/{name}/files/upload

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

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroup sökväg string Ja
name sökväg string Ja
component frågesträng string Nej
name frågesträng string Nej
path frågesträng string Nej

Begärans innehåll: binary

Svar

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

App Runtimes

GET /boundaries/{boundaryId}/resources/appruntimes

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

Apps

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

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

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

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

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

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Begärans innehåll: AppDto

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Begärans innehåll: AppDto

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/actions/{action}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
action sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/certificate-status

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments

  • Autentisering: krävs

Parametrar

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

Begärans innehåll: DeploymentLogEntryDto

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments/config

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

Parametrar

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

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments/{deploymentId}

  • Autentisering: krävs

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
appName 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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments/{deploymentId}/build-logs

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
deploymentId sökväg string Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/deployments/{deploymentId}/logs

  • Autentisering: krävs

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
appName 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/apps/{appName}/logs

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/metrics

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/metrics/web

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/pods

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/revisions/{number}/rollback

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
number sökväg integer Ja
ifMatchRevision frågesträng integer Nej

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/revisions/{number}/rollback-preview

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
number sökväg integer Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Begärans innehåll: SlotDto

Svar

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

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName 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 apps/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/actions/{action}

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja
action sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments

  • Autentisering: krävs

Parametrar

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

Begärans innehåll: DeploymentLogEntryDto

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments/config

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

Parametrar

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

Svar

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

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments/{deploymentId}

  • Autentisering: krävs

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
appName sökväg string Ja
slotName 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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments/{deploymentId}/build-logs

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja
deploymentId sökväg string Ja

Svar

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

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/deployments/{deploymentId}/logs

  • Autentisering: krävs

Parametrar

Namn Plats Typ Obligatorisk
boundaryId sökväg uuid Ja
resourceGroupName sökväg string Ja
appName sökväg string Ja
slotName 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/apps/{appName}/slots/{slotName}/logs

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/slots/{slotName}/pods

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja
slotName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/apps/{appName}/source-control

  • Autentisering: krävs
  • IAM-åtgärd: apps/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
appName sökväg string Ja

Svar

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

GET /boundaries/{boundaryId}/resources/apps

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

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

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

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

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

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

Parametrar

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

Begärans innehåll: AppNameRequest

Svar

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

Docs

GET /docs/apps/manifest.json

  • Autentisering: krävs
  • Operationsnamn: DocsManifest_apps

Svar

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

GET /docs/apps/{path}

  • Autentisering: krävs
  • Operationsnamn: DocsFile_apps

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

ActionType

Ett av: Allow, Deny.

AppComputePlanDto

Egenskap Typ Kan vara null
cpu integer Nej
description string Nej
name string Nej
pricePerMonth number Ja
ram integer Nej
storage integer Nej
storageType StorageType Nej

AppConfigDto

Egenskap Typ Kan vara null
appSettings map (string) Nej
detailedErrorLoggingEnabled boolean Nej
ipSecurityRestrictions SecurityRestrictionDto Nej

AppDto

Egenskap Typ Kan vara null
boundary string Nej
boundaryId uuid Nej
clusterId uuid Nej
clusterName string Nej
collection string Nej
computePlan string Nej
createdAt date-time Nej
hostname string Nej
id uuid Nej
kind string Nej
name string Nej
properties AppPropertiesDto Nej
region string Nej
resourceGroup string Nej
retention RetentionConfigDto Ja
scaling ScalingDto Ja
scalingStatus AppScalingStatusDto Ja
secrets map (string) Ja
slots SlotDto [] Nej
status string Nej
storage AppStorageDto Ja
tags map (string) Nej
url string Nej

AppNameRequest

Egenskap Typ Kan vara null
name string Nej
resourceGroupName string Ja

AppPropertiesDto

Egenskap Typ Kan vara null
additionalHostnames string [] Ja
appConfig AppConfigDto Ja
build BuildSettingsDto Ja
customDnsName string Ja
httpOnly boolean Nej
letsEncrypt boolean Nej
persistentStorage boolean Nej
port integer Nej
redirectHostnames string [] Ja
runtime string Nej
scm ScmDto Nej
version string Nej
wwwHostnames string [] Ja

AppRuntimeDto

Egenskap Typ Kan vara null
enabled boolean Nej
endOfLifeDate date Ja
name string Nej
runtime string Nej
version string Nej

AppScalingStatusDto

Egenskap Typ Kan vara null
message string Ja
ready boolean Nej
reason string Ja

AppStorageDto

Egenskap Typ Kan vara null
mountPath string Nej
size string Nej
storageClass string Ja

BuildSettingsDto

Egenskap Typ Kan vara null
buildTimeSettings string [] Ja
startProject string Ja

DeploymentLogEntryDto

Egenskap Typ Kan vara null
appName string Nej
boundaryId uuid Nej
branch string Ja
commitSha string Ja
containerImage string Ja
deploymentId uuid Nej
id uuid Nej
lastMessage string Nej
phase string Nej
provider string Ja
repositoryName string Ja
resourceGroupName string Nej
serveMode string Ja
slotName string Ja
source string Ja
timestamp date-time Nej

KedaTriggerDto

Egenskap Typ Kan vara null
metadata map (string) Nej
type string Nej

MakeDirectoryRequest

Egenskap Typ Kan vara null
component string Ja
path string Nej

MoveRequest

Egenskap Typ Kan vara null
component string Ja
from string Nej
to string Nej

PagedListResponse<AppComputePlanDto>

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

PagedListResponse<AppDto>

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

PagedListResponse<AppRuntimeDto>

Egenskap Typ Kan vara null
items AppRuntimeDto [] 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

RetentionConfigDto

Egenskap Typ Kan vara null
keepForDays integer Ja
keepLast integer Ja

ScalingDto

Egenskap Typ Kan vara null
hpa ScalingHpaDto Ja
keda ScalingKedaDto Ja
replicas integer Ja
type ScalingType Nej

ScalingHpaDto

Egenskap Typ Kan vara null
cpuTarget integer Nej
maxReplicas integer Ja
minReplicas integer Ja

ScalingKedaDto

Egenskap Typ Kan vara null
cooldownPeriod integer Ja
maxReplicas integer Nej
minReplicas integer Nej
pollingInterval integer Ja
triggers KedaTriggerDto [] Nej

ScalingType

Ett av: Manual, Hpa, Keda.

ScmDto

Egenskap Typ Kan vara null
appInstallationId string Ja
commit string Ja
defaultBranch string Ja
image string Nej
pinnedImage string Ja
repositoryId string Ja
tag string Nej
type ScmType Nej
url string Nej

ScmType

Ett av: GitHub, GitLab, AzureDevOps, Git, Container.

SecurityRestrictionDto

Egenskap Typ Kan vara null
action ActionType Nej
ipAddress string Nej
name string Nej

SlotDto

Egenskap Typ Kan vara null
appConfig AppConfigDto Nej
branch string Nej
build BuildSettingsDto Ja
commit string Ja
deployToken string Ja
hostname string Nej
name string Nej
pinnedImage string Ja
runtime string Nej
status string Nej
version string Nej

StorageType

Ett av: 0 = Standard, 1 = Premium.

UploadBuildLogsRequest

Egenskap Typ Kan vara null
appName string Nej
boundaryId string Nej
logs string Nej
resourceGroupName string Nej
timestamp date-time Nej