Summary
Gets all services and service groups
Description
Returns all available services and service group documents.
Route
GET /policy-manager/services-and-groups
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| query |
object |
yes |
Optional query parameters |
Copied to Clipboard
{
"query": {
"limit": 10,
"sort": "name",
"skip": 10
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"query": {
"title": "query",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"protocol": {
"type": "string"
},
"limit": {
"type": "integer"
},
"sort": {
"type": "string"
},
"skip": {
"type": "integer"
},
"order": {
"type": "integer"
}
},
"type": "object",
"examples": [
{
"limit": 10,
"sort": "name",
"skip": 10
}
]
}
},
"required": [
"query"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
All service and service group documents. |
Copied to Clipboard
{
"results": [
{
"id": "eiusmod dolore aliquip",
"type": "service",
"name": "cillum",
"description": "non eiusmod sed cillum",
"created": "1946-02-25T19:22:01.566Z",
"createdBy": "dolore Ut",
"lastUpdated": "1945-07-26T11:11:35.373Z",
"lastUpdatedBy": "dolor do",
"traffic": {
"protocol": 25029520
},
"services": [
"quis anim",
"magna et veniam pariatur id",
"fugiat ut veniam ut laborum"
]
},
{
"id": "irure Lorem non eiusmod",
"type": "serviceGroup",
"name": "dolor occaecat",
"description": "ut est",
"created": "2021-01-04T03:40:05.994Z",
"createdBy": "incididunt non in mollit qui",
"lastUpdated": "1996-01-02T23:16:47.309Z",
"lastUpdatedBy": "magna sed commodo aliqua dolor",
"traffic": {
"protocol": -4942970
},
"services": [
"ad",
"dolor sed exercitation consequat"
]
}
],
"pageData": {
"total": 26203963,
"skip": 70938457,
"limit": 11653432
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"title": "serviceOrServiceGroup",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"service",
"serviceGroup"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"traffic": {
"type": "object",
"properties": {
"protocol": {
"type": [
"null",
"integer"
]
}
},
"required": [
"protocol"
],
"additionalProperties": true
},
"services": {
"type": "array",
"items": {
"title": "serviceId",
"type": "string"
}
},
"created": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"type": "string"
}
},
"required": [
"id",
"type",
"name",
"description",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy"
]
}
},
"pageData": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"skip": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"skip",
"limit"
]
}
},
"required": [
"results",
"pageData"
]
}
