Service
List services
Changed onRetrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.
get/services
Request
- Base URLhttps://demo.ziti.dev/edge/client/v1
- Auth
- API key in header zt-session
- or OAuth 2Authorization code/oidc/authorizeToken URL/oidc/tokenScopesopenid
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
offsetinteger
filterstring
configTypesstring[]
roleFilterstring[]
roleSemanticstring
Response
A list of services
Example response
{
"data": [
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"config": {
"key": {
"key": "{}"
}
},
"configs": [
"configs",
"configs"
],
"encryptionRequired": true,
"maxIdleTimeMillis": 0,
"name": "name",
"permissions": [
"Dial",
"Dial"
],
"postureQueries": [
{
"isPassing": true,
"policyId": "policyId",
"policyType": null,
"postureQueries": [
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
},
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
}
]
},
{
"isPassing": true,
"policyId": "policyId",
"policyType": null,
"postureQueries": [
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
},
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
}
]
}
],
"roleAttributes": [
null,
null
],
"terminatorStrategy": "terminatorStrategy"
},
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"config": {
"key": {
"key": "{}"
}
},
"configs": [
"configs",
"configs"
],
"encryptionRequired": true,
"maxIdleTimeMillis": 0,
"name": "name",
"permissions": [
"Dial",
"Dial"
],
"postureQueries": [
{
"isPassing": true,
"policyId": "policyId",
"policyType": null,
"postureQueries": [
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
},
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
}
]
},
{
"isPassing": true,
"policyId": "policyId",
"policyType": null,
"postureQueries": [
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
},
{
"_links": {
"key": {
"comment": "comment",
"href": "https://openapi-generator.tech",
"method": "method"
}
},
"createdAt": "2000-01-23T04:56:07.000+00:00",
"id": "id",
"tags": {},
"updatedAt": "2000-01-23T04:56:07.000+00:00",
"isPassing": true,
"process": {
"osType": "Windows",
"path": "path"
},
"processes": [
{
"osType": "Windows",
"path": "path"
},
{
"osType": "Windows",
"path": "path"
}
],
"promptGracePeriodSeconds": 6,
"promptOnUnlock": true,
"promptOnWake": true,
"queryType": "OS",
"timeout": 1,
"timeoutAt": "2000-01-23T04:56:07.000+00:00",
"timeoutRemaining": 5
}
]
}
],
"roleAttributes": [
null,
null
],
"terminatorStrategy": "terminatorStrategy"
}
],
"meta": {
"apiEnrollmentVersion": "apiEnrollmentVersion",
"apiVersion": "apiVersion",
"filterableFields": [
"filterableFields",
"filterableFields"
],
"pagination": {
"limit": 0.8008281904610115,
"offset": 6.027456183070403,
"totalCount": 1.4658129805029452
}
}
}Changes
- breaking
the response property
//////became nullable for the status - breaking
the response property
///////////became nullable for the status
- breaking
- info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status
- info