Update a service; ports and checker timeout freeze with the host allocation
PATCH
/api/admin/services/{id}Authorization
AuthorizationBearer token · headerrequiredPath parameters
idstringrequiredmin length 1
Request body
requiredapplication/jsonnamestringmin length 1 · max length 64
descriptionstringmax length 4000
portsobject[]min items 1 · max items 8
Show propertiesHide properties
Array of
objectportintegerrequiredmin 1 · max 65535
protocolstringrequireddefault: "tcp"
Allowed:
tcpudpcheckerTimeoutSecondsinteger | nullShow propertiesHide properties
Any of:
integer
integernull
nullpositionintegermin 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
idstringrequirednumbernumberrequiredslugstringrequirednamestringrequireddescriptionstringrequiredimagestringrequiredimageDigeststringrequiredcheckerImagestringrequiredcheckerImageDigeststringrequiredpullUsernamestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullportsobject[]requiredShow propertiesHide properties
Array of
objectportnumberrequiredprotocolstringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringcheckerTimeoutSecondsnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullenabledbooleanrequiredpositionnumberrequiredsourceFileIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullcreatedBystring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredpullCredentialsSetbooleanrequired401
Unauthorized
errorstringrequired404
Response for status 404
errorstringrequired409
Response for status 409
errorstringrequired422
Validation failed
typestringrequiredonstringrequiredsummarystringmessagestringfoundanypropertystringexpectedstring500
Unhandled server error
errorstringrequired