Create a service; refused once the host is allocated or the network opens
POST
/api/admin/servicesAuthorization
AuthorizationBearer token · headerrequiredRequest body
requiredapplication/jsonslugstringrequiredmax length 32 · matches ^[a-z0-9][a-z0-9-]{0,31}$
namestringrequiredmin length 1 · max length 64
descriptionstringrequiredmax length 4000 · default: ""
imagestringrequiredmin length 1 · max length 512
imageDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
checkerImagestringrequiredmin length 1 · max length 512
checkerImageDigeststringrequiredmatches ^sha256:[a-f0-9]{64}$
portsobject[]requiredmin items 1 · max items 8
Show propertiesHide properties
Array of
objectportintegerrequiredmin 1 · max 65535
protocolstringrequireddefault: "tcp"
Allowed:
tcpudpflagStoresintegerrequiredmin 1 · max 8
checkerTimeoutSecondsinteger | nullrequireddefault: null
Show propertiesHide properties
Any of:
integer
integernull
nullResponses
200
Success
numbernumberrequiredcheckerTimeoutSecondsnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullidstringrequirednamestringrequireddescriptionstringrequiredslugstringrequiredimagestringrequiredimageDigeststringrequiredcheckerImagestringrequiredcheckerImageDigeststringrequiredportsobject[]requiredShow propertiesHide properties
Array of
objectportnumberrequiredprotocolstringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringpositionnumberrequiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>requiredenabledbooleanrequiredcreatedBystring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullpullUsernamestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullsourceFileIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullpullCredentialsSetbooleanrequired401
Unauthorized
errorstringrequired409
Response for status 409
errorstringrequired422
Validation failed
typestringrequiredonstringrequiredsummarystringmessagestringfoundanypropertystringexpectedstring500
Unhandled server error
errorstringrequired