Skip to content

Check Deployment

POST
/api/v1/deployments/{name}/check
curl --request POST \
--url https://aura.strangeworks.com/api/v1/deployments/example/check \
--header 'Authorization: Bearer <token>'

Assert the deployment satisfies the external Run contract. Stateless.

name
required
Name
string

Successful Response

Media typeapplication/json
DeploymentCheckResponse
object
missing
required
Missing
Array<string>
ok
required
Ok
boolean
warnings
required
Warnings
Array<string>
Examplegenerated
{
"missing": [
"example"
],
"ok": true,
"warnings": [
"example"
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}