v1

latestOpenAPI 3.0.1Apache 2.02026-07-1759153352.8 KB
Service

List services

Retrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.

get/services

Query parameters

limitinteger
offsetinteger
filterstring
configTypesstring[]
roleFilterstring[]
roleSemanticstring

Response

A list of services

Example response

{
  "data": [
    {
      "maxIdleTimeMillis": 0,
      "configs": [
        "configs",
        "configs"
      ],
      "_links": {
        "key": {
          "method": "method",
          "comment": "comment",
          "href": "https://openapi-generator.tech"
        }
      },
      "encryptionRequired": true,
      "terminatorStrategy": "terminatorStrategy",
      "tags": {},
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "roleAttributes": [
        null,
        null
      ],
      "postureQueries": [
        {
          "policyId": "policyId",
          "postureQueries": [
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            },
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            }
          ],
          "policyType": null,
          "isPassing": true
        },
        {
          "policyId": "policyId",
          "postureQueries": [
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            },
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            }
          ],
          "policyType": null,
          "isPassing": true
        }
      ],
      "permissions": [
        "Dial",
        "Dial"
      ],
      "name": "name",
      "id": "id",
      "config": {
        "key": {
          "key": "{}"
        }
      },
      "updatedAt": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "maxIdleTimeMillis": 0,
      "configs": [
        "configs",
        "configs"
      ],
      "_links": {
        "key": {
          "method": "method",
          "comment": "comment",
          "href": "https://openapi-generator.tech"
        }
      },
      "encryptionRequired": true,
      "terminatorStrategy": "terminatorStrategy",
      "tags": {},
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "roleAttributes": [
        null,
        null
      ],
      "postureQueries": [
        {
          "policyId": "policyId",
          "postureQueries": [
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            },
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            }
          ],
          "policyType": null,
          "isPassing": true
        },
        {
          "policyId": "policyId",
          "postureQueries": [
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            },
            {
              "promptOnWake": true,
              "timeoutRemaining": 5,
              "process": {
                "path": "path",
                "osType": "Windows"
              },
              "processes": [
                {
                  "path": "path",
                  "osType": "Windows"
                },
                {
                  "path": "path",
                  "osType": "Windows"
                }
              ],
              "_links": {
                "key": {
                  "method": "method",
                  "comment": "comment",
                  "href": "https://openapi-generator.tech"
                }
              },
              "promptOnUnlock": true,
              "timeoutAt": "2000-01-23T04:56:07.000+00:00",
              "promptGracePeriodSeconds": 6,
              "timeout": 1,
              "tags": {},
              "queryType": "OS",
              "createdAt": "2000-01-23T04:56:07.000+00:00",
              "id": "id",
              "isPassing": true,
              "updatedAt": "2000-01-23T04:56:07.000+00:00"
            }
          ],
          "policyType": null,
          "isPassing": true
        }
      ],
      "permissions": [
        "Dial",
        "Dial"
      ],
      "name": "name",
      "id": "id",
      "config": {
        "key": {
          "key": "{}"
        }
      },
      "updatedAt": "2000-01-23T04:56:07.000+00:00"
    }
  ],
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "pagination": {
      "offset": 6.027456183070403,
      "limit": 0.8008281904610115,
      "totalCount": 1.4658129805029452
    },
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ]
  }
}