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

List services

GET/api/admin/services
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Success

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

Unauthorized

errorstringrequired
500

Unhandled server error

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