Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Update a service; ports and checker timeout freeze with the host allocation

PATCH/api/admin/services/{id}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
idstringrequired
min length 1
Request body
requiredapplication/json
namestring
min length 1 · max length 64
descriptionstring
max length 4000
portsobject[]
min items 1 · max items 8
Show properties
Array of object
portintegerrequired
min 1 · max 65535
protocolstringrequired
default: "tcp"
Allowed:tcpudp
checkerTimeoutSecondsinteger | null
Show properties
Any of:
integer
integer
null
null
positioninteger
min 0 · max 9007199254740991
expectedUpdatedAtstring<date-time>
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Responses
200

Success

idstringrequired
numbernumberrequired
slugstringrequired
namestringrequired
descriptionstringrequired
imagestringrequired
imageDigeststringrequired
checkerImagestringrequired
checkerImageDigeststringrequired
pullUsernamestring | nullrequired
Show properties
Any of:
string
string
null
null
portsobject[]required
Show properties
Array of object
portnumberrequired
protocolstringrequired
Show properties
Any of:
string
string
string
string
checkerTimeoutSecondsnumber | nullrequired
Show properties
Any of:
number
number
null
null
enabledbooleanrequired
positionnumberrequired
sourceFileIdstring | nullrequired
Show properties
Any of:
string
string
null
null
createdBystring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstring<date-time>required
updatedAtstring<date-time>required
pullCredentialsSetbooleanrequired
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
409

Response for status 409

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH '/api/admin/services/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "ports": [
    {
      "port": 1,
      "protocol": "tcp"
    }
  ],
  "checkerTimeoutSeconds": 5,
  "position": 0,
  "expectedUpdatedAt": "2019-08-24T14:15:22Z"
}'
Response
{
  "id": "string",
  "number": 0,
  "slug": "string",
  "name": "string",
  "description": "string",
  "image": "string",
  "imageDigest": "string",
  "checkerImage": "string",
  "checkerImageDigest": "string",
  "pullUsername": "string",
  "ports": [
    {
      "port": 0,
      "protocol": "tcp"
    }
  ],
  "checkerTimeoutSeconds": 0,
  "enabled": true,
  "position": 0,
  "sourceFileId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "pullCredentialsSet": true
}