The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the nextPageKey query parameter.
When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of ActiveGate tokens in a single response payload.
The maximal allowed page size is 3000 and the minimal size is 100.
If not set, 100 is used.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateTokenList](#activegatetokenlist)|200|Success. The response contains the list of ActiveGate tokens.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.|\n\n\nThe ID of the token to be deleted.
You can specify either the ID or the secret of the token.
You can't delete the token you're using for authentication of the request.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn't have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. You can't delete the token you're using for authentication of the request. | Client side error. | Server side error.|\n\n\nFilters the resulting sets of tokens. Only tokens matching the specified criteria are included into response.
You can set one or more of the following criteria:
owner("value"). The user that owns the token. Case-sensitive.personalAccessToken(false). Set to true to include only personal access tokens or to false to include only API tokens.scope("scope1","scope2"). If several values are specified, the OR logic applies.To set multiple criteria, separate them with commas (,). Only results matching all criteria are included into response.
Specifies the fields to be included in the response.
The following fields are included by default:
idnameenabledownercreationDateTo remove fields from the response, specify them with the minus (-) operator as a comma-separated list (for example, -creationDate,-owner).
You can include additional fields:
personalAccessToken
expirationDate
lastUsedDate
lastUsedIpAddress
modifiedDate
scopes
additionalMetadata
To add fields to the response, specify them with the plus (+) operator as a comma-separated list (for example, +expirationDate,+scopes). You can combine adding and removing of fields (for example, +scopes,-creationDate).
Alternatively, you can define the desired set of fields in the response. Specify the required fields as a comma-separated list, without operators (for example, creationDate,expirationDate,owner). The ID is always included in the response.
The fields string must be URL-encoded.
|\n|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters tokens based on the last usage time. The start of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsThe cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the nextPageKey query parameter.
When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.
|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of API tokens in a single response payload.
The maximal allowed page size is 10000 and the minimal allowed page size is 100.
If not set, 200 is used.
|\n|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The sort order of the token list.
You can sort by the following properties with a sign prefix for the sort order:
name: token name (+ a...z or - z...a)lastUsedDate last used (+ never used tokens first - most recently used tokens first)creationDate (+ oldest tokens first - newest tokens first)expirationDate (+ tokens that expire soon first - unlimited tokens first)modifiedDate last modified (+ never modified tokens first - most recently modified tokens first)If no prefix is set, + is used.
If not set, tokens are sorted by creation date with newest first.
-creationDate|\n|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters tokens based on the last usage time. The end of the requested timeframe.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the current timestamp is used.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ApiTokenList](#apitokenlist)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. The input is invalid. | Client side error. | Server side error.|\n\n\nThe ID of the token to be updated.
You can't disable the token you're using for authentication of the request.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn't have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. The input is invalid. | Client side error. | Server side error.|\n\n\nThe start of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the relative timeframe of one day is used (now-1d).
Maximum timeframe is 31 days.
|\n|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Iftrue, filters the resulting set of update jobs to the most recent update of each type.false|\n|config.startVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>).|\n|config.startVersionCompareType|\"EQUAL\" | \"GREATER\" | \"GREATER_EQUAL\" | \"LOWER\" | \"LOWER_EQUAL\"|Filters the resulting set of update jobs by the specified initial version.
Specify the comparison operator here.
|\n|config.targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the target version (required format<major>.<minor>.<revision>).|\n|config.targetVersionCompareType|\"EQUAL\" | \"GREATER\" | \"GREATER_EQUAL\" | \"LOWER\" | \"LOWER_EQUAL\"|Filters the resulting set of update jobs by the specified target version.
Specify the comparison operator here.
|\n|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The end of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the current timestamp is used.
|\n|config.updateType|\"SYNTHETIC\" | \"ACTIVE_GATE\" | \"REMOTE_PLUGIN_AGENT\" | \"Z_REMOTE\"|Filters the resulting set of update-jobs by the update type.ACTIVE_GATE|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[UpdateJobsAll](#updatejobsall)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. The input is invalid. | Client side error. | Server side error.|\n\n\nThe start of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the relative timeframe of one week is used (now-1w).
Maximum timeframe is 31 days.
|\n|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Iftrue, filters the resulting set of update jobs to the most recent update of each type.false|\n|config.startVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>).|\n|config.startVersionCompareType|\"EQUAL\" | \"GREATER\" | \"GREATER_EQUAL\" | \"LOWER\" | \"LOWER_EQUAL\"|Filters the resulting set of update jobs by the specified initial version.
Specify the comparison operator here.
|\n|config.targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the target version (required format<major>.<minor>.<revision>).|\n|config.targetVersionCompareType|\"EQUAL\" | \"GREATER\" | \"GREATER_EQUAL\" | \"LOWER\" | \"LOWER_EQUAL\"|Filters the resulting set of update jobs by the specified target version.
Specify the comparison operator here.
|\n|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The end of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutesh: hoursd: daysw: weeksM: monthsy: yearsIf not set, the current timestamp is used.
|\n|config.updateType|\"SYNTHETIC\" | \"ACTIVE_GATE\" | \"REMOTE_PLUGIN_AGENT\" | \"Z_REMOTE\"|Filters the resulting set of update-jobs by the update type.ACTIVE_GATE|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[UpdateJobList](#updatejoblist)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Not found. See response body for details. | Client side error. | Server side error.|\n\n\ntrue) or not (false).|\n|config.disabledModule|Array<\"SYNTHETIC\" | \"AWS\" | \"AZURE\" | \"BEACON_FORWARDER\" | \"CLOUD_FOUNDRY\" | \"DB_INSIGHT\" | \"DEBUGGING\" | \"EXTENSIONS_V1\" | \"EXTENSIONS_V2\" | \"KUBERNETES\" | \"LOGS\" | \"MEMORY_DUMPS\" | \"METRIC_API\" | \"ONE_AGENT_ROUTING\" | \"OTLP_INGEST\" | \"REST_API\" | \"VMWARE\" | \"Z_OS\">|Filters the resulting set of ActiveGates by the disabled modules.|\n|config.enabledModule|Array<\"SYNTHETIC\" | \"AWS\" | \"AZURE\" | \"BEACON_FORWARDER\" | \"CLOUD_FOUNDRY\" | \"DB_INSIGHT\" | \"DEBUGGING\" | \"EXTENSIONS_V1\" | \"EXTENSIONS_V2\" | \"KUBERNETES\" | \"LOGS\" | \"MEMORY_DUMPS\" | \"METRIC_API\" | \"ONE_AGENT_ROUTING\" | \"OTLP_INGEST\" | \"REST_API\" | \"VMWARE\" | \"Z_OS\">|Filters the resulting set of ActiveGates by the enabled modules.|\n|config.fipsMode|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Filters the resulting set of ActiveGates to those which are running in FIPS mode (true) or not (false).|\n|config.group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of ActiveGates by the group.
You can specify a partial name. In that case, the CONTAINS operator is used.
Filters the resulting set of ActiveGates by the name of the host it's running on.
You can specify a partial name. In that case, the CONTAINS operator is used.