OrkStageOrkStage
API referenceCI/CD intake

PUT /applications/{name}

PUT /applications/{name}: OrkStage Control API v1 endpoint reference.

PUT
/api/v1/applications/{name}

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

name*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
displayName*string
Length1 <= length <= 120
repository*string
Length3 <= length <= 500
registryKind?string
Default"ecr"
Value in"ecr""acr""ocir""gar""dockerhub""ghcr""other"
port*integer
Range1 <= value <= 65535
healthPath?string
Match^\/.*
Formatstarts_with
Lengthlength <= 200
Default"/health"
readinessPath?string
Match^\/.*
Formatstarts_with
Lengthlength <= 200

Response Body

curl -X PUT 'http://localhost:4300/api/v1/applications/string' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "string",  "repository": "string",  "port": 1}'
Empty
Edit on GitHub

POST /templates/validate POST

POST /templates/validate: OrkStage Control API v1 endpoint reference.

POST /applications/{name}/versions POST

POST /applications/{name}/versions: OrkStage Control API v1 endpoint reference.