Red Hat SummitThis documentation is for a release that is no longer maintained.
You can select a different version or view all RHACS documentation.API reference
API Reference guide for Red Hat Advanced Cluster Security for Kubernetes.
Abstract
Chapter 1. Administration Event Service
1.1. Administration Event Service
1.1.1. CountAdministrationEvents
GET /v1/count/administration/events
CountAdministrationEvents returns the number of events after filtering by requested fields.
1.1.1.1. Description
1.1.1.2. Parameters
1.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| filter.from | Matches events with last_occurred_at after a specific timestamp, i.e. the lower boundary. | - | null | |
| filter.until | Matches events with last_occurred_at before a specific timestamp, i.e. the upper boundary. | - | null | |
| filter.domain |
Matches events from a specific domain. | - | null | |
| filter.resourceType |
Matches events associated with a specific resource type. | - | null | |
| filter.type |
Matches events based on their type. | - | null | |
| filter.level |
Matches events based on their level. | - | null |
1.1.1.3. Return Type
1.1.1.4. Content Type
- application/json
1.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
1.1.1.6. Samples
1.1.2. GetAdministrationEvent
GET /v1/administration/events/{id}
GetAdministrationEvent retrieves an event by ID.
1.1.2.1. Description
1.1.2.2. Parameters
1.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
1.1.2.3. Return Type
1.1.2.4. Content Type
- application/json
1.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
1.1.2.6. Samples
1.1.3. ListAdministrationEvents
GET /v1/administration/events
ListAdministrationEvents returns the list of events after filtered by requested fields.
1.1.3.1. Description
1.1.3.2. Parameters
1.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| filter.from | Matches events with last_occurred_at after a specific timestamp, i.e. the lower boundary. | - | null | |
| filter.until | Matches events with last_occurred_at before a specific timestamp, i.e. the upper boundary. | - | null | |
| filter.domain |
Matches events from a specific domain. | - | null | |
| filter.resourceType |
Matches events associated with a specific resource type. | - | null | |
| filter.type |
Matches events based on their type. | - | null | |
| filter.level |
Matches events based on their level. | - | null |
1.1.3.3. Return Type
1.1.3.4. Content Type
- application/json
1.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
1.1.3.6. Samples
Chapter 2. Administration Usage Service
2.1. Administration Usage Service
2.1.1. GetCurrentSecuredUnitsUsage
GET /v1/administration/usage/secured-units/current
GetCurrentSecuredUnitsUsage returns the current secured units usage metrics values.
2.1.1.1. Description
The secured units metrics are collected from all connected clusters every 5 minutes, so the returned result includes data for the connected clusters accurate to about these 5 minutes, and potentially some outdated data for the disconnected clusters.
2.1.1.2. Parameters
2.1.1.3. Return Type
2.1.1.4. Content Type
- application/json
2.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
2.1.1.6. Samples
2.1.2. GetMaxSecuredUnitsUsage
GET /v1/administration/usage/secured-units/max
GetMaxSecuredUnitsUsage returns the maximum, i.e. peak, secured units usage observed during a given time range, together with the time when this maximum was aggregated and stored.
2.1.2.1. Description
The usage metrics are continuously collected from all the connected clusters. The maximum values are kept for some period of time in memory, and then, periodically, are stored to the database. The last data from disconnected clusters are taken into account.
2.1.2.2. Parameters
2.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| from | - | null | ||
| to | - | null |
2.1.2.3. Return Type
2.1.2.4. Content Type
- application/json
2.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
2.1.2.6. Samples
Chapter 3. Alert Service
3.1. Alert Service
3.1.1. CountAlerts
GET /v1/alertscount
CountAlerts counts how many alerts match the get request.
3.1.1.1. Description
3.1.1.2. Parameters
3.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.1.3. Return Type
3.1.1.4. Content Type
- application/json
3.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.1.6. Samples
3.1.2. DeleteAlerts
DELETE /v1/alerts
3.1.2.1. Description
3.1.2.2. Parameters
3.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null | ||
| confirm | - | null |
3.1.2.3. Return Type
3.1.2.4. Content Type
- application/json
3.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.2.6. Samples
3.1.3. GetAlert
GET /v1/alerts/{id}
GetAlert returns the alert given its id.
3.1.3.1. Description
3.1.3.2. Parameters
3.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
3.1.3.3. Return Type
3.1.3.4. Content Type
- application/json
3.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.3.6. Samples
3.1.4. GetAlertTimeseries
GET /v1/alerts/summary/timeseries
GetAlertTimeseries returns the alerts sorted by time.
3.1.4.1. Description
3.1.4.2. Parameters
3.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.4.3. Return Type
3.1.4.4. Content Type
- application/json
3.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.4.6. Samples
3.1.5. GetAlertsCounts
GET /v1/alerts/summary/counts
GetAlertsCounts returns the number of alerts in the requested cluster or category.
3.1.5.1. Description
3.1.5.2. Parameters
3.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| request.query | - | null | ||
| request.pagination.limit | - | null | ||
| request.pagination.offset | - | null | ||
| request.pagination.sortOption.field | - | null | ||
| request.pagination.sortOption.reversed | - | null | ||
| request.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| request.pagination.sortOption.aggregateBy.distinct | - | null | ||
| groupBy | - | UNSET |
3.1.5.3. Return Type
3.1.5.4. Content Type
- application/json
3.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.5.6. Samples
3.1.6. GetAlertsGroup
GET /v1/alerts/summary/groups
GetAlertsGroup returns alerts grouped by policy.
3.1.6.1. Description
3.1.6.2. Parameters
3.1.6.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.6.3. Return Type
3.1.6.4. Content Type
- application/json
3.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.6.6. Samples
3.1.7. ListAlerts
GET /v1/alerts
List returns the slim list version of the alerts.
3.1.7.1. Description
3.1.7.2. Parameters
3.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.7.3. Return Type
3.1.7.4. Content Type
- application/json
3.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
3.1.7.6. Samples
3.1.8. ResolveAlert
PATCH /v1/alerts/{id}/resolve
ResolveAlert marks the given alert (by ID) as resolved.
3.1.8.1. Description
3.1.8.2. Parameters
3.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
3.1.8.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
3.1.8.3. Return Type
Object
3.1.8.4. Content Type
- application/json
3.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
3.1.8.6. Samples
3.1.9. ResolveAlerts
PATCH /v1/alerts/resolve
ResolveAlertsByQuery marks alerts matching search query as resolved.
3.1.9.1. Description
3.1.9.2. Parameters
3.1.9.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
3.1.9.3. Return Type
Object
3.1.9.4. Content Type
- application/json
3.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
3.1.9.6. Samples
3.1.10. SnoozeAlert
PATCH /v1/alerts/{id}/snooze
SnoozeAlert is deprecated.
3.1.10.1. Description
3.1.10.2. Parameters
3.1.10.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
3.1.10.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
3.1.10.3. Return Type
Object
3.1.10.4. Content Type
- application/json
3.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
3.1.10.6. Samples
Chapter 4. APIToken Service
4.1. A P I Token Service
4.1.1. GenerateToken
POST /v1/apitokens/generate
GenerateToken generates API token for a given user and role.
4.1.1.1. Description
4.1.1.2. Parameters
4.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
4.1.1.3. Return Type
4.1.1.4. Content Type
- application/json
4.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
4.1.1.6. Samples
4.1.2. GetAPIToken
GET /v1/apitokens/{id}
GetAPIToken returns API token metadata for a given id.
4.1.2.1. Description
4.1.2.2. Parameters
4.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
4.1.2.3. Return Type
4.1.2.4. Content Type
- application/json
4.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
4.1.2.6. Samples
4.1.3. GetAPITokens
GET /v1/apitokens
GetAPITokens returns all the API tokens.
4.1.3.1. Description
4.1.3.2. Parameters
4.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| revoked | - | null |
4.1.3.3. Return Type
4.1.3.4. Content Type
- application/json
4.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
4.1.3.6. Samples
4.1.4. ListAllowedTokenRoles
GET /v1/apitokens/generate/allowed-roles
GetAllowedTokenRoles return roles that user is allowed to request for API token.
4.1.4.1. Description
4.1.4.2. Parameters
4.1.4.3. Return Type
4.1.4.4. Content Type
- application/json
4.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
4.1.4.6. Samples
4.1.5. RevokeToken
PATCH /v1/apitokens/revoke/{id}
RevokeToken removes the API token for a given id.
4.1.5.1. Description
4.1.5.2. Parameters
4.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
4.1.5.3. Return Type
Object
4.1.5.4. Content Type
- application/json
4.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
4.1.5.6. Samples
Chapter 5. Auth Provider Service
5.1. Auth Provider Service
5.1.1. DeleteAuthProvider
DELETE /v1/authProviders/{id}
5.1.1.1. Description
5.1.1.2. Parameters
5.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
5.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| force | - | null |
5.1.1.3. Return Type
Object
5.1.1.4. Content Type
- application/json
5.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
5.1.1.6. Samples
5.1.2. ExchangeToken
POST /v1/authProviders/exchangeToken
5.1.2.1. Description
5.1.2.2. Parameters
5.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
5.1.2.3. Return Type
5.1.2.4. Content Type
- application/json
5.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.2.6. Samples
5.1.3. GetAuthProvider
GET /v1/authProviders/{id}
5.1.3.1. Description
5.1.3.2. Parameters
5.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
5.1.3.3. Return Type
5.1.3.4. Content Type
- application/json
5.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.3.6. Samples
5.1.4. GetAuthProviders
GET /v1/authProviders
5.1.4.1. Description
5.1.4.2. Parameters
5.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name | - | null | ||
| type | - | null |
5.1.4.3. Return Type
5.1.4.4. Content Type
- application/json
5.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.4.6. Samples
5.1.5. GetLoginAuthProviders
GET /v1/login/authproviders
5.1.5.1. Description
5.1.5.2. Parameters
5.1.5.3. Return Type
5.1.5.4. Content Type
- application/json
5.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.5.6. Samples
5.1.6. ListAvailableProviderTypes
GET /v1/availableAuthProviders
5.1.6.1. Description
5.1.6.2. Parameters
5.1.6.3. Return Type
5.1.6.4. Content Type
- application/json
5.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.6.6. Samples
5.1.7. PostAuthProvider
POST /v1/authProviders
5.1.7.1. Description
5.1.7.2. Parameters
5.1.7.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| provider | X |
5.1.7.3. Return Type
5.1.7.4. Content Type
- application/json
5.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.7.6. Samples
5.1.8. PutAuthProvider
PUT /v1/authProviders/{id}
5.1.8.1. Description
5.1.8.2. Parameters
5.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
5.1.8.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
5.1.8.3. Return Type
5.1.8.4. Content Type
- application/json
5.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.8.6. Samples
5.1.9. UpdateAuthProvider
PATCH /v1/authProviders/{id}
5.1.9.1. Description
5.1.9.2. Parameters
5.1.9.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
5.1.9.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
5.1.9.3. Return Type
5.1.9.4. Content Type
- application/json
5.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
5.1.9.6. Samples
Chapter 6. Auth Service
6.1. Auth Service
6.1.1. AddAuthMachineToMachineConfig
POST /v1/auth/m2m
AddAuthMachineToMachineConfig creates a new auth machine to machine config.
6.1.1.1. Description
6.1.1.2. Parameters
6.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.1.3. Return Type
6.1.1.4. Content Type
- application/json
6.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.1.6. Samples
6.1.2. DeleteAuthMachineToMachineConfig
DELETE /v1/auth/m2m/{id}
DeleteAuthMachineToMachineConfig deletes the specific auth machine to machine config. In case a specified auth machine to machine config does not exist is deleted, no error will be returned.
6.1.2.1. Description
6.1.2.2. Parameters
6.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
6.1.2.3. Return Type
Object
6.1.2.4. Content Type
- application/json
6.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
6.1.2.6. Samples
6.1.3. ExchangeAuthMachineToMachineToken
POST /v1/auth/m2m/exchange
ExchangeAuthMachineToMachineToken exchanges a given identity token for a Central access token based on configured auth machine to machine configs.
6.1.3.1. Description
6.1.3.2. Parameters
6.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.3.3. Return Type
6.1.3.4. Content Type
- application/json
6.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.3.6. Samples
6.1.4. GetAuthMachineToMachineConfig
GET /v1/auth/m2m/{id}
GetAuthMachineToMachineConfig retrieves the specific auth machine to machine config.
6.1.4.1. Description
6.1.4.2. Parameters
6.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
6.1.4.3. Return Type
6.1.4.4. Content Type
- application/json
6.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.4.6. Samples
6.1.5. GetAuthStatus
GET /v1/auth/status
GetAuthStatus returns the status for the current client.
6.1.5.1. Description
6.1.5.2. Parameters
6.1.5.3. Return Type
6.1.5.4. Content Type
- application/json
6.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.5.6. Samples
6.1.6. ListAuthMachineToMachineConfigs
GET /v1/auth/m2m
ListAuthMachineToMachineConfigs lists the available auth machine to machine configs.
6.1.6.1. Description
6.1.6.2. Parameters
6.1.6.3. Return Type
6.1.6.4. Content Type
- application/json
6.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.6.6. Samples
6.1.7. UpdateAuthMachineToMachineConfig
PUT /v1/auth/m2m/{config.id}
UpdateAuthMachineToMachineConfig updates an existing auth machine to machine config. In case the auth machine to machine config does not exist, a new one will be created.
6.1.7.1. Description
6.1.7.2. Parameters
6.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| config.id | UUID of the config. Note that when adding a machine to machine config, this field should not be set. | X | null |
6.1.7.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.7.3. Return Type
Object
6.1.7.4. Content Type
- application/json
6.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
6.1.7.6. Samples
Chapter 7. Central Health Service
7.1. Central Health Service
7.1.1. GetUpgradeStatus
GET /v1/centralhealth/upgradestatus
7.1.1.1. Description
7.1.1.2. Parameters
7.1.1.3. Return Type
7.1.1.4. Content Type
- application/json
7.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
7.1.1.6. Samples
Chapter 8. Cloud Sources Service
8.1. Cloud Sources Service
8.1.1. CountCloudSources
GET /v1/count/cloud-sources
CountCloudSources returns the number of cloud sources after filtering by requested fields.
8.1.1.1. Description
8.1.1.2. Parameters
8.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| filter.names |
Matches cloud sources based on their name. | - | null | |
| filter.types |
Matches cloud sources based on their type. | - | null |
8.1.1.3. Return Type
8.1.1.4. Content Type
- application/json
8.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.1.6. Samples
8.1.2. CreateCloudSource
POST /v1/cloud-sources
CreateCloudSource creates a cloud source.
8.1.2.1. Description
8.1.2.2. Parameters
8.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.2.3. Return Type
8.1.2.4. Content Type
- application/json
8.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.2.6. Samples
8.1.3. DeleteCloudSource
DELETE /v1/cloud-sources/{id}
DeleteCloudSource removes a cloud source.
8.1.3.1. Description
8.1.3.2. Parameters
8.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
8.1.3.3. Return Type
Object
8.1.3.4. Content Type
- application/json
8.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
8.1.3.6. Samples
8.1.4. GetCloudSource
GET /v1/cloud-sources/{id}
GetCloudSource retrieves a cloud source by ID.
8.1.4.1. Description
8.1.4.2. Parameters
8.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
8.1.4.3. Return Type
8.1.4.4. Content Type
- application/json
8.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.4.6. Samples
8.1.5. ListCloudSources
GET /v1/cloud-sources
ListCloudSources returns the list of cloud sources after filtered by requested fields.
8.1.5.1. Description
8.1.5.2. Parameters
8.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| filter.names |
Matches cloud sources based on their name. | - | null | |
| filter.types |
Matches cloud sources based on their type. | - | null |
8.1.5.3. Return Type
8.1.5.4. Content Type
- application/json
8.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.5.6. Samples
8.1.6. TestCloudSource
POST /v1/cloud-sources/test
TestCloudSource tests a cloud source.
8.1.6.1. Description
8.1.6.2. Parameters
8.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.6.3. Return Type
Object
8.1.6.4. Content Type
- application/json
8.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
8.1.6.6. Samples
8.1.7. UpdateCloudSource
PUT /v1/cloud-sources/{cloudSource.id}
UpdateCloudSource creates or replaces a cloud source.
8.1.7.1. Description
8.1.7.2. Parameters
8.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| cloudSource.id | X | null |
8.1.7.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.7.3. Return Type
Object
8.1.7.4. Content Type
- application/json
8.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
8.1.7.6. Samples
Chapter 9. Cluster CVEService
9.1. Cluster C V E Service
9.1.1. SuppressCVEs
PATCH /v1/clustercves/suppress
SuppressCVE suppresses cluster cves.
9.1.1.1. Description
9.1.1.2. Parameters
9.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
9.1.1.3. Return Type
Object
9.1.1.4. Content Type
- application/json
9.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
9.1.1.6. Samples
9.1.2. UnsuppressCVEs
PATCH /v1/clustercves/unsuppress
UnsuppressCVE unsuppresses cluster cves.
9.1.2.1. Description
9.1.2.2. Parameters
9.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
9.1.2.3. Return Type
Object
9.1.2.4. Content Type
- application/json
9.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
9.1.2.6. Samples
Chapter 10. Cluster Init Service
10.1. Cluster Init Service
10.1.1. GenerateCRS
POST /v1/cluster-init/crs
10.1.1.1. Description
10.1.1.2. Parameters
10.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
10.1.1.3. Return Type
10.1.1.4. Content Type
- application/json
10.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.1.6. Samples
10.1.2. GenerateInitBundle
POST /v1/cluster-init/init-bundles
10.1.2.1. Description
10.1.2.2. Parameters
10.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
10.1.2.3. Return Type
10.1.2.4. Content Type
- application/json
10.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.2.6. Samples
10.1.3. GetCAConfig
GET /v1/cluster-init/ca-config
10.1.3.1. Description
10.1.3.2. Parameters
10.1.3.3. Return Type
10.1.3.4. Content Type
- application/json
10.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.3.6. Samples
10.1.4. GetCRSs
GET /v1/cluster-init/crs
10.1.4.1. Description
10.1.4.2. Parameters
10.1.4.3. Return Type
10.1.4.4. Content Type
- application/json
10.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.4.6. Samples
10.1.5. GetInitBundles
GET /v1/cluster-init/init-bundles
10.1.5.1. Description
10.1.5.2. Parameters
10.1.5.3. Return Type
10.1.5.4. Content Type
- application/json
10.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.5.6. Samples
10.1.6. RevokeCRS
PATCH /v1/cluster-init/crs/revoke
RevokeCRSBundle deletes cluster registration secrets.
10.1.6.1. Description
10.1.6.2. Parameters
10.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
10.1.6.3. Return Type
10.1.6.4. Content Type
- application/json
10.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.6.6. Samples
10.1.7. RevokeInitBundle
PATCH /v1/cluster-init/init-bundles/revoke
RevokeInitBundle deletes cluster init bundle. If this operation impacts any cluster then its ID should be included in request. If confirm_impacted_clusters_ids does not match with current impacted clusters then request will fail with error that includes all impacted clusters.
10.1.7.1. Description
10.1.7.2. Parameters
10.1.7.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
10.1.7.3. Return Type
10.1.7.4. Content Type
- application/json
10.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
10.1.7.6. Samples
Chapter 11. Clusters Service
11.1. Clusters Service
11.1.1. DeleteCluster
DELETE /v1/clusters/{id}
11.1.1.1. Description
11.1.1.2. Parameters
11.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
11.1.1.3. Return Type
Object
11.1.1.4. Content Type
- application/json
11.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
11.1.1.6. Samples
11.1.2. GetCluster
GET /v1/clusters/{id}
11.1.2.1. Description
11.1.2.2. Parameters
11.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
11.1.2.3. Return Type
11.1.2.4. Content Type
- application/json
11.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.2.6. Samples
11.1.3. GetClusterDefaultValues
GET /v1/cluster-defaults
11.1.3.1. Description
11.1.3.2. Parameters
11.1.3.3. Return Type
11.1.3.4. Content Type
- application/json
11.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.3.6. Samples
11.1.4. GetClusters
GET /v1/clusters
11.1.4.1. Description
11.1.4.2. Parameters
11.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null |
11.1.4.3. Return Type
11.1.4.4. Content Type
- application/json
11.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.4.6. Samples
11.1.5. GetKernelSupportAvailable
GET /v1/clusters-env/kernel-support-available
GetKernelSupportAvailable is deprecated in favor of GetClusterDefaultValues.
11.1.5.1. Description
11.1.5.2. Parameters
11.1.5.3. Return Type
11.1.5.4. Content Type
- application/json
11.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.5.6. Samples
11.1.6. PostCluster
POST /v1/clusters
11.1.6.1. Description
11.1.6.2. Parameters
11.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
11.1.6.3. Return Type
11.1.6.4. Content Type
- application/json
11.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.6.6. Samples
11.1.7. PutCluster
PUT /v1/clusters/{id}
11.1.7.1. Description
11.1.7.2. Parameters
11.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
11.1.7.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
11.1.7.3. Return Type
11.1.7.4. Content Type
- application/json
11.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
11.1.7.6. Samples
Chapter 12. Collection Service
12.1. Collection Service
12.1.1. CreateCollection
POST /v1/collections
12.1.1.1. Description
12.1.1.2. Parameters
12.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
12.1.1.3. Return Type
12.1.1.4. Content Type
- application/json
12.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.1.6. Samples
12.1.2. DeleteCollection
DELETE /v1/collections/{id}
12.1.2.1. Description
12.1.2.2. Parameters
12.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
12.1.2.3. Return Type
Object
12.1.2.4. Content Type
- application/json
12.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
12.1.2.6. Samples
12.1.3. DryRunCollection
POST /v1/collections/dryrun
12.1.3.1. Description
12.1.3.2. Parameters
12.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
12.1.3.3. Return Type
12.1.3.4. Content Type
- application/json
12.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.3.6. Samples
12.1.4. GetCollection
GET /v1/collections/{id}
12.1.4.1. Description
12.1.4.2. Parameters
12.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
12.1.4.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| options.withMatches | - | null | ||
| options.filterQuery.query | - | null | ||
| options.filterQuery.pagination.limit | - | null | ||
| options.filterQuery.pagination.offset | - | null | ||
| options.filterQuery.pagination.sortOption.field | - | null | ||
| options.filterQuery.pagination.sortOption.reversed | - | null | ||
| options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| options.filterQuery.pagination.sortOption.aggregateBy.distinct | - | null |
12.1.4.3. Return Type
12.1.4.4. Content Type
- application/json
12.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.4.6. Samples
12.1.5. GetCollectionCount
GET /v1/collectionscount
12.1.5.1. Description
12.1.5.2. Parameters
12.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
12.1.5.3. Return Type
12.1.5.4. Content Type
- application/json
12.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.5.6. Samples
12.1.6. ListCollectionSelectors
GET /v1/collections/selectors
12.1.6.1. Description
12.1.6.2. Parameters
12.1.6.3. Return Type
12.1.6.4. Content Type
- application/json
12.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.6.6. Samples
12.1.7. ListCollections
GET /v1/collections
12.1.7.1. Description
12.1.7.2. Parameters
12.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
12.1.7.3. Return Type
12.1.7.4. Content Type
- application/json
12.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.7.6. Samples
12.1.8. UpdateCollection
PATCH /v1/collections/{id}
12.1.8.1. Description
12.1.8.2. Parameters
12.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
12.1.8.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
12.1.8.3. Return Type
12.1.8.4. Content Type
- application/json
12.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
12.1.8.6. Samples
Chapter 13. Compliance Integration Service
13.1. Compliance Integration Service
13.1.1. ListComplianceIntegrations
GET /v2/compliance/integrations
ListComplianceIntegrations lists all the compliance operator metadata for the secured clusters
13.1.1.1. Description
13.1.1.2. Parameters
13.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
13.1.1.3. Return Type
13.1.1.4. Content Type
- application/json
13.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
13.1.1.6. Samples
Chapter 14. Compliance Management Service
14.1. Compliance Management Service
14.1.1. GetRecentRuns
GET /v1/complianceManagement/runs
14.1.1.1. Description
14.1.1.2. Parameters
14.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | - | null | ||
| standardId | - | null | ||
| since | - | null |
14.1.1.3. Return Type
14.1.1.4. Content Type
- application/json
14.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
14.1.1.6. Samples
14.1.2. GetRunStatuses
GET /v1/compliancemanagement/runstatuses
14.1.2.1. Description
14.1.2.2. Parameters
14.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| runIds |
| - | null | |
| latest | - | null |
14.1.2.3. Return Type
14.1.2.4. Content Type
- application/json
14.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
14.1.2.6. Samples
14.1.3. TriggerRuns
POST /v1/compliancemanagement/runs
14.1.3.1. Description
14.1.3.2. Parameters
14.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
14.1.3.3. Return Type
14.1.3.4. Content Type
- application/json
14.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
14.1.3.6. Samples
Chapter 15. Compliance Profile Service
15.1. Compliance Profile Service
15.1.1. GetComplianceProfile
GET /v2/compliance/profile/{id}
GetComplianceProfile retrieves the specified compliance profile
15.1.1.1. Description
15.1.1.2. Parameters
15.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
15.1.1.3. Return Type
15.1.1.4. Content Type
- application/json
15.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
15.1.1.6. Samples
15.1.2. ListComplianceProfiles
GET /v2/compliance/profiles/cluster
ListComplianceProfiles returns profiles matching given request
15.1.2.1. Description
15.1.2.2. Parameters
15.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | - | null | ||
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
15.1.2.3. Return Type
15.1.2.4. Content Type
- application/json
15.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
15.1.2.6. Samples
15.1.3. ListProfileSummaries
GET /v2/compliance/profiles/summary
ListProfileSummaries returns profiles matching each cluster and the given query
15.1.3.1. Description
15.1.3.2. Parameters
15.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterIds |
| - | null | |
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
15.1.3.3. Return Type
15.1.3.4. Content Type
- application/json
15.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
15.1.3.6. Samples
Chapter 16. Compliance Results Service
16.1. Compliance Results Service
16.1.1. GetComplianceProfileCheckDetails
GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}/details
GetComplianceProfileCheckDetails
16.1.1.1. Description
16.1.1.2. Parameters
16.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null | ||
| checkName | X | null |
16.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
16.1.1.3. Return Type
16.1.1.4. Content Type
- application/json
16.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.1.6. Samples
16.1.2. GetComplianceProfileCheckResult
GET /v2/compliance/scan/results/profiles/{profileName}/checks/{checkName}
GetComplianceProfileCheckResult lists status of a check per cluster
16.1.2.1. Description
16.1.2.2. Parameters
16.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null | ||
| checkName | X | null |
16.1.2.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
16.1.2.3. Return Type
16.1.2.4. Content Type
- application/json
16.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.2.6. Samples
16.1.3. GetComplianceProfileClusterResults
GET /v2/compliance/scan/results/profiles/{profileName}/clusters/{clusterId}
GetComplianceProfileClusterResults lists check results for a specific profile on a specific cluster
16.1.3.1. Description
16.1.3.2. Parameters
16.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null | ||
| clusterId | X | null |
16.1.3.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
16.1.3.3. Return Type
16.1.3.4. Content Type
- application/json
16.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.3.6. Samples
16.1.4. GetComplianceProfileResults
GET /v2/compliance/scan/results/profiles/{profileName}/checks
GetComplianceProfileResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined.
16.1.4.1. Description
16.1.4.2. Parameters
16.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null |
16.1.4.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
16.1.4.3. Return Type
16.1.4.4. Content Type
- application/json
16.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.4.6. Samples
16.1.5. GetComplianceScanCheckResult
GET /v2/compliance/scan/result/{id}
GetComplianceScanCheckResult returns the specific result by ID
16.1.5.1. Description
16.1.5.2. Parameters
16.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
16.1.5.3. Return Type
16.1.5.4. Content Type
- application/json
16.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.5.6. Samples
16.1.6. GetComplianceScanConfigurationResults
GET /v2/compliance/scan/results/{scanConfigName}
GetComplianceScanConfigurationResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined.
16.1.6.1. Description
16.1.6.2. Parameters
16.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| scanConfigName | X | null |
16.1.6.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
16.1.6.3. Return Type
16.1.6.4. Content Type
- application/json
16.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.6.6. Samples
16.1.7. GetComplianceScanResults
GET /v2/compliance/scan/results
GetComplianceScanResults retrieves the most recent compliance operator scan results for the specified query Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile
16.1.7.1. Description
16.1.7.2. Parameters
16.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
16.1.7.3. Return Type
16.1.7.4. Content Type
- application/json
16.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
16.1.7.6. Samples
Chapter 17. Compliance Results Stats Service
17.1. Compliance Results Stats Service
17.1.1. GetComplianceClusterScanStats
GET /v2/compliance/stats/configurations/clusters/{clusterId}
GetComplianceClusterScanStats lists the current scan stats for a cluster for each scan configuration
17.1.1.1. Description
17.1.1.2. Parameters
17.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
17.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.1.3. Return Type
17.1.1.4. Content Type
- application/json
17.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.1.6. Samples
17.1.2. GetComplianceClusterStats
GET /v2/compliance/scan/stats/profiles/{profileName}/clusters
17.1.2.1. Description
17.1.2.2. Parameters
17.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null |
17.1.2.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.2.3. Return Type
17.1.2.4. Content Type
- application/json
17.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.2.6. Samples
17.1.3. GetComplianceOverallClusterStats
GET /v2/compliance/scan/stats/overall/cluster
Deprecated in favor of GetComplianceClusterStats
17.1.3.1. Description
17.1.3.2. Parameters
17.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
17.1.3.3. Return Type
17.1.3.4. Content Type
- application/json
17.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.3.6. Samples
17.1.4. GetComplianceProfileCheckStats
GET /v2/compliance/scan/stats/profiles/{profileName}/checks/{checkName}
GetComplianceProfileCheckStats lists current stats for a specific cluster check
17.1.4.1. Description
17.1.4.2. Parameters
17.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null | ||
| checkName | X | null |
17.1.4.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.4.3. Return Type
17.1.4.4. Content Type
- application/json
17.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.4.6. Samples
17.1.5. GetComplianceProfileStats
GET /v2/compliance/scan/stats/profiles/{profileName}
GetComplianceProfileStats lists current scan stats grouped by profile Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile
17.1.5.1. Description
17.1.5.2. Parameters
17.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| profileName | X | null |
17.1.5.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.5.3. Return Type
17.1.5.4. Content Type
- application/json
17.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.5.6. Samples
17.1.6. GetComplianceProfilesClusterStats
GET /v2/compliance/scan/stats/profiles/clusters/{clusterId}
GetComplianceProfilesClusterStats lists cluster stats grouped by profile
17.1.6.1. Description
17.1.6.2. Parameters
17.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
17.1.6.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.6.3. Return Type
17.1.6.4. Content Type
- application/json
17.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.6.6. Samples
17.1.7. GetComplianceProfilesStats
GET /v2/compliance/scan/stats/profiles
GetComplianceProfileScanStats lists current scan stats grouped by profile Optional RawQuery query fields can be combined. Commonly used ones include but are not limited to - scan: id(s) of the compliance scan - cluster: id(s) of the cluster - profile: id(s) of the profile
17.1.7.1. Description
17.1.7.2. Parameters
17.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
17.1.7.3. Return Type
17.1.7.4. Content Type
- application/json
17.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
17.1.7.6. Samples
Chapter 18. Compliance Rule Service
18.1. Compliance Rule Service
18.1.1. GetComplianceRule
GET /v2/compliance/rule/summary/{ruleName}
GetComplianceRule returns rule matching given request
18.1.1.1. Description
18.1.1.2. Parameters
18.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| ruleName | X | null |
18.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
18.1.1.3. Return Type
18.1.1.4. Content Type
- application/json
18.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
18.1.1.6. Samples
Chapter 19. Compliance Scan Configuration Service
19.1. Compliance Scan Configuration Service
19.1.1. CreateComplianceScanConfiguration
POST /v2/compliance/scan/configurations
CreateComplianceScanConfiguration creates a compliance scan configuration
19.1.1.1. Description
19.1.1.2. Parameters
19.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
19.1.1.3. Return Type
19.1.1.4. Content Type
- application/json
19.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.1.6. Samples
19.1.2. DeleteComplianceScanConfiguration
DELETE /v2/compliance/scan/configurations/{id}
DeleteComplianceScanConfiguration removes the compliance scan configuration with given Name
19.1.2.1. Description
19.1.2.2. Parameters
19.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.2.3. Return Type
Object
19.1.2.4. Content Type
- application/json
19.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
19.1.2.6. Samples
19.1.3. DeleteReport
DELETE /v2/compliance/scan/configurations/reports/{id}
DeleteReport deletes a given snapshot (scan execution).
19.1.3.1. Description
19.1.3.2. Parameters
19.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.3.3. Return Type
Object
19.1.3.4. Content Type
- application/json
19.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
19.1.3.6. Samples
19.1.4. GetComplianceScanConfiguration
GET /v2/compliance/scan/configurations/{id}
GetComplianceScanConfiguration retrieves the specified compliance scan configurations
19.1.4.1. Description
19.1.4.2. Parameters
19.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.4.3. Return Type
19.1.4.4. Content Type
- application/json
19.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.4.6. Samples
19.1.5. GetMyReportHistory
GET /v2/compliance/scan/configurations/{id}/reports/my-history
GetMyReportHistory returns a list of snapshots (scan executions) executed by the current user from a given scan configuration.
19.1.5.1. Description
19.1.5.2. Parameters
19.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.5.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
19.1.5.3. Return Type
19.1.5.4. Content Type
- application/json
19.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.5.6. Samples
19.1.6. GetReportHistory
GET /v2/compliance/scan/configurations/{id}/reports/history
GetReportHistory returns a list of snapshots (scan executions) from a given scan configuration.
19.1.6.1. Description
19.1.6.2. Parameters
19.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.6.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
19.1.6.3. Return Type
19.1.6.4. Content Type
- application/json
19.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.6.6. Samples
19.1.7. ListComplianceScanConfigClusterProfiles
GET /v2/compliance/scan/configurations/clusters/{clusterId}/profiles/collection
GetComplianceScanConfiguration retrieves the specified compliance scan configurations
19.1.7.1. Description
19.1.7.2. Parameters
19.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
19.1.7.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
19.1.7.3. Return Type
19.1.7.4. Content Type
- application/json
19.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.7.6. Samples
19.1.8. ListComplianceScanConfigProfiles
GET /v2/compliance/scan/configurations/profiles/collection
ListComplianceScanConfigurations lists all the compliance operator scan configurations for the secured clusters
19.1.8.1. Description
19.1.8.2. Parameters
19.1.8.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
19.1.8.3. Return Type
19.1.8.4. Content Type
- application/json
19.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.8.6. Samples
19.1.9. ListComplianceScanConfigurations
GET /v2/compliance/scan/configurations
ListComplianceScanConfigurations lists all the compliance operator scan configurations for the secured clusters
19.1.9.1. Description
19.1.9.2. Parameters
19.1.9.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
19.1.9.3. Return Type
19.1.9.4. Content Type
- application/json
19.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.9.6. Samples
19.1.10. RunComplianceScanConfiguration
POST /v2/compliance/scan/configurations/{id}/run
RunComplianceScanConfiguration launches scan for the specified scan configuration, which will invoke scans to run for the applicable profiles across the configured clusters.
19.1.10.1. Description
19.1.10.2. Parameters
19.1.10.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.10.3. Return Type
Object
19.1.10.4. Content Type
- application/json
19.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
19.1.10.6. Samples
19.1.11. RunReport
POST /v2/compliance/scan/configurations/reports/run
RunReport runs an on demand compliance report for the scan configuration
19.1.11.1. Description
19.1.11.2. Parameters
19.1.11.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
19.1.11.3. Return Type
19.1.11.4. Content Type
- application/json
19.1.11.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
19.1.11.6. Samples
19.1.12. UpdateComplianceScanConfiguration
PUT /v2/compliance/scan/configurations/{id}
UpdateComplianceScanConfiguration updates a compliance scan configuration
19.1.12.1. Description
19.1.12.2. Parameters
19.1.12.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
19.1.12.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | ComplianceScanConfigurationServiceUpdateComplianceScanConfigurationBody | X |
19.1.12.3. Return Type
Object
19.1.12.4. Content Type
- application/json
19.1.12.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
19.1.12.6. Samples
Chapter 20. Compliance Service
20.1. Compliance Service
20.1.1. GetAggregatedResults
GET /v1/compliance/aggregatedresults
20.1.1.1. Description
20.1.1.2. Parameters
20.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| groupBy |
| - | null | |
| unit | - | UNKNOWN | ||
| where.query | - | null | ||
| where.pagination.limit | - | null | ||
| where.pagination.offset | - | null | ||
| where.pagination.sortOption.field | - | null | ||
| where.pagination.sortOption.reversed | - | null | ||
| where.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| where.pagination.sortOption.aggregateBy.distinct | - | null |
20.1.1.3. Return Type
20.1.1.4. Content Type
- application/json
20.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
20.1.1.6. Samples
20.1.2. GetRunResults
GET /v1/compliance/runresults
20.1.2.1. Description
20.1.2.2. Parameters
20.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | - | null | ||
| standardId | - | null | ||
| runId | Specifies the run ID for which to return results. If empty, the most recent run is returned. CAVEAT: Setting this field circumvents the results cache on the server-side, which may lead to significantly increased memory pressure and decreased performance. | - | null |
20.1.2.3. Return Type
20.1.2.4. Content Type
- application/json
20.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
20.1.2.6. Samples
20.1.3. GetStandard
GET /v1/compliance/standards/{id}
20.1.3.1. Description
20.1.3.2. Parameters
20.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
20.1.3.3. Return Type
20.1.3.4. Content Type
- application/json
20.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
20.1.3.6. Samples
20.1.4. GetStandards
GET /v1/compliance/standards
20.1.4.1. Description
20.1.4.2. Parameters
20.1.4.3. Return Type
20.1.4.4. Content Type
- application/json
20.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
20.1.4.6. Samples
20.1.5. UpdateComplianceStandardConfig
PATCH /v1/compliance/standards/{id}
20.1.5.1. Description
20.1.5.2. Parameters
20.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
20.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
20.1.5.3. Return Type
Object
20.1.5.4. Content Type
- application/json
20.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
20.1.5.6. Samples
Chapter 21. Config Service
21.1. Config Service
21.1.1. GetConfig
GET /v1/config
21.1.1.1. Description
21.1.1.2. Parameters
21.1.1.3. Return Type
21.1.1.4. Content Type
- application/json
21.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.1.6. Samples
21.1.2. GetPrivateConfig
GET /v1/config/private
21.1.2.1. Description
21.1.2.2. Parameters
21.1.2.3. Return Type
21.1.2.4. Content Type
- application/json
21.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.2.6. Samples
21.1.3. GetPublicConfig
GET /v1/config/public
21.1.3.1. Description
21.1.3.2. Parameters
21.1.3.3. Return Type
21.1.3.4. Content Type
- application/json
21.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.3.6. Samples
21.1.4. GetVulnerabilityExceptionConfig
GET /v1/config/private/exception/vulnerabilities
21.1.4.1. Description
21.1.4.2. Parameters
21.1.4.3. Return Type
21.1.4.4. Content Type
- application/json
21.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.4.6. Samples
21.1.5. PutConfig
PUT /v1/config
21.1.5.1. Description
21.1.5.2. Parameters
21.1.5.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
21.1.5.3. Return Type
21.1.5.4. Content Type
- application/json
21.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.5.6. Samples
21.1.6. UpdateVulnerabilityExceptionConfig
PUT /v1/config/private/exception/vulnerabilities
21.1.6.1. Description
21.1.6.2. Parameters
21.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
21.1.6.3. Return Type
21.1.6.4. Content Type
- application/json
21.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
21.1.6.6. Samples
Chapter 22. Credential Expiry Service
22.1. Credential Expiry Service
22.1.1. GetCertExpiry
GET /v1/credentialexpiry
GetCertExpiry returns information related to the expiry component mTLS certificate.
22.1.1.1. Description
22.1.1.2. Parameters
22.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| component | - | UNKNOWN |
22.1.1.3. Return Type
22.1.1.4. Content Type
- application/json
22.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
22.1.1.6. Samples
Chapter 23. DBService
23.1. D B Service
23.1.1. CancelRestoreProcess
DELETE /v1/db/restore/{id}
23.1.1.1. Description
23.1.1.2. Parameters
23.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
23.1.1.3. Return Type
Object
23.1.1.4. Content Type
- application/json
23.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
23.1.1.6. Samples
23.1.2. GetActiveRestoreProcess
GET /v1/db/restore
23.1.2.1. Description
23.1.2.2. Parameters
23.1.2.3. Return Type
23.1.2.4. Content Type
- application/json
23.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
23.1.2.6. Samples
23.1.3. GetExportCapabilities
GET /v1/db/exportcaps
23.1.3.1. Description
23.1.3.2. Parameters
23.1.3.3. Return Type
23.1.3.4. Content Type
- application/json
23.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
23.1.3.6. Samples
23.1.4. InterruptRestoreProcess
POST /v1/db/interruptrestore/{processId}/{attemptId}
23.1.4.1. Description
23.1.4.2. Parameters
23.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| processId | X | null | ||
| attemptId | X | null |
23.1.4.3. Return Type
23.1.4.4. Content Type
- application/json
23.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
23.1.4.6. Samples
Chapter 24. Debug Service
24.1. Debug Service
24.1.1. GetLogLevel
GET /v1/debug/loglevel
Get the current logging level for StackRox services.
24.1.1.1. Description
24.1.1.2. Parameters
24.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| modules |
| - | null |
24.1.1.3. Return Type
24.1.1.4. Content Type
- application/json
24.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
24.1.1.6. Samples
24.1.2. ResetDBStats
POST /v1/debug/db/stats/reset
Reset database debugging statistics.
24.1.2.1. Description
24.1.2.2. Parameters
24.1.2.3. Return Type
Object
24.1.2.4. Content Type
- application/json
24.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
24.1.2.6. Samples
24.1.3. SetLogLevel
PATCH /v1/debug/loglevel
Set logging level for StackRox services.
24.1.3.1. Description
24.1.3.2. Parameters
24.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
24.1.3.3. Return Type
Object
24.1.3.4. Content Type
- application/json
24.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
24.1.3.6. Samples
24.1.4. StreamAuthzTraces
GET /v1/debug/authz/trace
Stream authorization traces for all incoming requests.
24.1.4.1. Description
24.1.4.2. Parameters
24.1.4.3. Return Type
Stream result of v1AuthorizationTraceResponse.
24.1.4.4. Content Type
- application/json
24.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | Stream result of v1AuthorizationTraceResponse. |
| 0 | An unexpected error response. |
24.1.4.6. Samples
Chapter 25. Declarative Config Health Service
25.1. Declarative Config Health Service
25.1.1. GetDeclarativeConfigHealths
GET /v1/declarative-config/health
25.1.1.1. Description
25.1.1.2. Parameters
25.1.1.3. Return Type
25.1.1.4. Content Type
- application/json
25.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
25.1.1.6. Samples
Chapter 26. Delegated Registry Config Service
26.1. Delegated Registry Config Service
26.1.1. GetClusters
GET /v1/delegatedregistryconfig/clusters
GetClusters returns the list of clusters (id + name) and a flag indicating whether or not the cluster is valid for use in the delegated registry config
26.1.1.1. Description
26.1.1.2. Parameters
26.1.1.3. Return Type
26.1.1.4. Content Type
- application/json
26.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
26.1.1.6. Samples
26.1.2. GetConfig
GET /v1/delegatedregistryconfig
GetConfig returns the current delegated registry configuration
26.1.2.1. Description
26.1.2.2. Parameters
26.1.2.3. Return Type
26.1.2.4. Content Type
- application/json
26.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
26.1.2.6. Samples
26.1.3. UpdateConfig
PUT /v1/delegatedregistryconfig
UpdateConfig updates the stored delegated registry configuration
26.1.3.1. Description
26.1.3.2. Parameters
26.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | DelegatedRegistryConfig determines if and where scan requests are delegated to, such as kept in central services or sent to particular secured clusters. V1DelegatedRegistryConfig | X |
26.1.3.3. Return Type
26.1.3.4. Content Type
- application/json
26.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
26.1.3.6. Samples
Chapter 27. Deployment Service
27.1. Deployment Service
27.1.1. CountDeployments
GET /v1/deploymentscount
CountDeployments returns the number of deployments.
27.1.1.1. Description
27.1.1.2. Parameters
27.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
27.1.1.3. Return Type
27.1.1.4. Content Type
- application/json
27.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.1.6. Samples
27.1.2. ExportDeployments
GET /v1/export/deployments
27.1.2.1. Description
27.1.2.2. Parameters
27.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
27.1.2.3. Return Type
Stream result of v1ExportDeploymentResponse.
27.1.2.4. Content Type
- application/json
27.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | Stream result of v1ExportDeploymentResponse. |
| 0 | An unexpected error response. |
27.1.2.6. Samples
27.1.3. GetDeployment
GET /v1/deployments/{id}
GetDeployment returns a deployment given its ID.
27.1.3.1. Description
27.1.3.2. Parameters
27.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
27.1.3.3. Return Type
27.1.3.4. Content Type
- application/json
27.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.3.6. Samples
27.1.4. GetDeploymentWithRisk
GET /v1/deploymentswithrisk/{id}
GetDeploymentWithRisk returns a deployment and its risk given its ID.
27.1.4.1. Description
27.1.4.2. Parameters
27.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
27.1.4.3. Return Type
27.1.4.4. Content Type
- application/json
27.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.4.6. Samples
27.1.5. GetLabels
GET /v1/deployments/metadata/labels
GetLabels returns the labels used by deployments.
27.1.5.1. Description
27.1.5.2. Parameters
27.1.5.3. Return Type
27.1.5.4. Content Type
- application/json
27.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.5.6. Samples
27.1.6. ListDeployments
GET /v1/deployments
ListDeployments returns the list of deployments.
27.1.6.1. Description
27.1.6.2. Parameters
27.1.6.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
27.1.6.3. Return Type
27.1.6.4. Content Type
- application/json
27.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.6.6. Samples
27.1.7. ListDeploymentsWithProcessInfo
GET /v1/deploymentswithprocessinfo
ListDeploymentsWithProcessInfo returns the list of deployments with process information.
27.1.7.1. Description
27.1.7.2. Parameters
27.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
27.1.7.3. Return Type
27.1.7.4. Content Type
- application/json
27.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
27.1.7.6. Samples
Chapter 28. Detection Service
28.1. Detection Service
28.1.1. DetectBuildTime
POST /v1/detect/build
DetectBuildTime checks if any images violate build time policies.
28.1.1.1. Description
28.1.1.2. Parameters
28.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
28.1.1.3. Return Type
28.1.1.4. Content Type
- application/json
28.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
28.1.1.6. Samples
28.1.2. DetectDeployTime
POST /v1/detect/deploy
DetectDeployTime checks if any deployments violate deploy time policies.
28.1.2.1. Description
28.1.2.2. Parameters
28.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
28.1.2.3. Return Type
28.1.2.4. Content Type
- application/json
28.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
28.1.2.6. Samples
28.1.3. DetectDeployTimeFromYAML
POST /v1/detect/deploy/yaml
DetectDeployTimeFromYAML checks if the given deployment yaml violates any deploy time policies.
28.1.3.1. Description
28.1.3.2. Parameters
28.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
28.1.3.3. Return Type
28.1.3.4. Content Type
- application/json
28.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
28.1.3.6. Samples
Chapter 29. Discovered Clusters Service
29.1. Discovered Clusters Service
29.1.1. CountDiscoveredClusters
GET /v1/count/discovered-clusters
CountDiscoveredClusters returns the number of discovered clusters after filtering by requested fields.
29.1.1.1. Description
29.1.1.2. Parameters
29.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| filter.names |
Matches discovered clusters of specific names. | - | null | |
| filter.types |
Matches discovered clusters of specific types. | - | null | |
| filter.statuses |
Matches discovered clusters of specific statuses. - STATUS_UNSPECIFIED: The status of the cluster is unknown. May occur if a secured cluster is missing the metadata for a possible match. - STATUS_SECURED: The discovered cluster was matched with a secured cluster. - STATUS_UNSECURED: The discovered cluster was not matched with a secured cluster. | - | null | |
| filter.sourceIds |
Matches discovered clusters of specific cloud source IDs. | - | null |
29.1.1.3. Return Type
29.1.1.4. Content Type
- application/json
29.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
29.1.1.6. Samples
29.1.2. GetDiscoveredCluster
GET /v1/discovered-clusters/{id}
GetDiscoveredCluster retrieves a discovered cluster by ID.
29.1.2.1. Description
29.1.2.2. Parameters
29.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
29.1.2.3. Return Type
29.1.2.4. Content Type
- application/json
29.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
29.1.2.6. Samples
29.1.3. ListDiscoveredClusters
GET /v1/discovered-clusters
ListDiscoveredClusters returns the list of discovered clusters after filtered by requested fields.
29.1.3.1. Description
29.1.3.2. Parameters
29.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| filter.names |
Matches discovered clusters of specific names. | - | null | |
| filter.types |
Matches discovered clusters of specific types. | - | null | |
| filter.statuses |
Matches discovered clusters of specific statuses. - STATUS_UNSPECIFIED: The status of the cluster is unknown. May occur if a secured cluster is missing the metadata for a possible match. - STATUS_SECURED: The discovered cluster was matched with a secured cluster. - STATUS_UNSECURED: The discovered cluster was not matched with a secured cluster. | - | null | |
| filter.sourceIds |
Matches discovered clusters of specific cloud source IDs. | - | null |
29.1.3.3. Return Type
29.1.3.4. Content Type
- application/json
29.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
29.1.3.6. Samples
Chapter 30. External Backup Service
30.1. External Backup Service
30.1.1. DeleteExternalBackup
DELETE /v1/externalbackups/{id}
DeleteExternalBackup removes an external backup configuration given its ID.
30.1.1.1. Description
30.1.1.2. Parameters
30.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
30.1.1.3. Return Type
Object
30.1.1.4. Content Type
- application/json
30.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
30.1.1.6. Samples
30.1.2. GetExternalBackup
GET /v1/externalbackups/{id}
GetExternalBackup returns the external backup configuration given its ID.
30.1.2.1. Description
30.1.2.2. Parameters
30.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
30.1.2.3. Return Type
30.1.2.4. Content Type
- application/json
30.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
30.1.2.6. Samples
30.1.3. GetExternalBackups
GET /v1/externalbackups
GetExternalBackups returns all external backup configurations.
30.1.3.1. Description
30.1.3.2. Parameters
30.1.3.3. Return Type
30.1.3.4. Content Type
- application/json
30.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
30.1.3.6. Samples
30.1.4. PostExternalBackup
POST /v1/externalbackups
PostExternalBackup creates an external backup configuration.
30.1.4.1. Description
30.1.4.2. Parameters
30.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
30.1.4.3. Return Type
30.1.4.4. Content Type
- application/json
30.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
30.1.4.6. Samples
30.1.5. PutExternalBackup
PUT /v1/externalbackups/{id}
PutExternalBackup modifies a given external backup, without using stored credential reconciliation.
30.1.5.1. Description
30.1.5.2. Parameters
30.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
30.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
30.1.5.3. Return Type
30.1.5.4. Content Type
- application/json
30.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
30.1.5.6. Samples
30.1.6. TestExternalBackup
POST /v1/externalbackups/test
TestExternalBackup tests an external backup configuration.
30.1.6.1. Description
30.1.6.2. Parameters
30.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
30.1.6.3. Return Type
Object
30.1.6.4. Content Type
- application/json
30.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
30.1.6.6. Samples
30.1.7. TestUpdatedExternalBackup
POST /v1/externalbackups/test/updated
TestUpdatedExternalBackup checks if the given external backup is correctly configured, with optional stored credential reconciliation.
30.1.7.1. Description
30.1.7.2. Parameters
30.1.7.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
30.1.7.3. Return Type
Object
30.1.7.4. Content Type
- application/json
30.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
30.1.7.6. Samples
30.1.8. TriggerExternalBackup
POST /v1/externalbackups/{id}
TriggerExternalBackup initiates an external backup for the given configuration.
30.1.8.1. Description
30.1.8.2. Parameters
30.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
30.1.8.3. Return Type
Object
30.1.8.4. Content Type
- application/json
30.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
30.1.8.6. Samples
30.1.9. UpdateExternalBackup
PATCH /v1/externalbackups/{externalBackup.id}
UpdateExternalBackup modifies a given external backup, with optional stored credential reconciliation.
30.1.9.1. Description
30.1.9.2. Parameters
30.1.9.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| externalBackup.id | X | null |
30.1.9.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
30.1.9.3. Return Type
30.1.9.4. Content Type
- application/json
30.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
30.1.9.6. Samples
Chapter 31. Feature Flag Service
31.1. Feature Flag Service
31.1.1. GetFeatureFlags
GET /v1/featureflags
31.1.1.1. Description
31.1.1.2. Parameters
31.1.1.3. Return Type
31.1.1.4. Content Type
- application/json
31.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
31.1.1.6. Samples
Chapter 32. Group Service
32.1. Group Service
32.1.1. BatchUpdate
POST /v1/groupsbatch
32.1.1.1. Description
32.1.1.2. Parameters
32.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
32.1.1.3. Return Type
Object
32.1.1.4. Content Type
- application/json
32.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
32.1.1.6. Samples
32.1.2. CreateGroup
POST /v1/groups
32.1.2.1. Description
32.1.2.2. Parameters
32.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | Group is a GroupProperties : Role mapping. StorageGroup | X |
32.1.2.3. Return Type
Object
32.1.2.4. Content Type
- application/json
32.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
32.1.2.6. Samples
32.1.3. DeleteGroup
DELETE /v1/groups
32.1.3.1. Description
32.1.3.2. Parameters
32.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| authProviderId | We copy over parameters from storage.GroupProperties for seamless HTTP API migration. | - | null | |
| key | - | null | ||
| value | - | null | ||
| id | - | null | ||
| force | - | null |
32.1.3.3. Return Type
Object
32.1.3.4. Content Type
- application/json
32.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
32.1.3.6. Samples
32.1.4. GetGroup
GET /v1/group
32.1.4.1. Description
32.1.4.2. Parameters
32.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | Unique identifier for group properties and respectively the group. | - | null | |
| traits.mutabilityMode | - | ALLOW_MUTATE | ||
| traits.visibility | - | VISIBLE | ||
| traits.origin | - | IMPERATIVE | ||
| authProviderId | - | null | ||
| key | - | null | ||
| value | - | null |
32.1.4.3. Return Type
32.1.4.4. Content Type
- application/json
32.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
32.1.4.6. Samples
32.1.5. GetGroups
GET /v1/groups
32.1.5.1. Description
32.1.5.2. Parameters
32.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| authProviderId | - | null | ||
| key | - | null | ||
| value | - | null | ||
| id | - | null |
32.1.5.3. Return Type
32.1.5.4. Content Type
- application/json
32.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
32.1.5.6. Samples
32.1.6. UpdateGroup
PUT /v1/groups
32.1.6.1. Description
32.1.6.2. Parameters
32.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| group | X |
32.1.6.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| force | - | null |
32.1.6.3. Return Type
Object
32.1.6.4. Content Type
- application/json
32.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
32.1.6.6. Samples
Chapter 33. GRPCPreferences Service
33.1. G R P C Preferences Service
33.1.1. Get
GET /v1/grpc-preferences
33.1.1.1. Description
33.1.1.2. Parameters
33.1.1.3. Return Type
33.1.1.4. Content Type
- application/json
33.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
33.1.1.6. Samples
Chapter 34. Image CVEService
34.1. Image C V E Service
34.1.1. SuppressCVEs
PATCH /v1/imagecves/suppress
SuppressCVE suppresses image cves.
34.1.1.1. Description
34.1.1.2. Parameters
34.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
34.1.1.3. Return Type
Object
34.1.1.4. Content Type
- application/json
34.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
34.1.1.6. Samples
34.1.2. UnsuppressCVEs
PATCH /v1/imagecves/unsuppress
UnsuppressCVE unsuppresses image cves.
34.1.2.1. Description
34.1.2.2. Parameters
34.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
34.1.2.3. Return Type
Object
34.1.2.4. Content Type
- application/json
34.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
34.1.2.6. Samples
Chapter 35. Image Integration Service
35.1. Image Integration Service
35.1.1. DeleteImageIntegration
DELETE /v1/imageintegrations/{id}
DeleteImageIntegration removes a image integration given its ID.
35.1.1.1. Description
35.1.1.2. Parameters
35.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.1.3. Return Type
Object
35.1.1.4. Content Type
- application/json
35.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.1.6. Samples
35.1.2. GetImageIntegration
GET /v1/imageintegrations/{id}
GetImageIntegration returns the image integration given its ID.
35.1.2.1. Description
35.1.2.2. Parameters
35.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.2.3. Return Type
35.1.2.4. Content Type
- application/json
35.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.2.6. Samples
35.1.3. GetImageIntegrations
GET /v1/imageintegrations
GetImageIntegrations returns all image integrations that match the request filters.
35.1.3.1. Description
35.1.3.2. Parameters
35.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name | - | null | ||
| cluster | - | null |
35.1.3.3. Return Type
35.1.3.4. Content Type
- application/json
35.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.3.6. Samples
35.1.4. PostImageIntegration
POST /v1/imageintegrations
PostImageIntegration creates a image integration.
35.1.4.1. Description
35.1.4.2. Parameters
35.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.4.3. Return Type
35.1.4.4. Content Type
- application/json
35.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
35.1.4.6. Samples
35.1.5. PutImageIntegration
PUT /v1/imageintegrations/{id}
PutImageIntegration modifies a given image integration, without using stored credential reconciliation.
35.1.5.1. Description
35.1.5.2. Parameters
35.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
35.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.5.3. Return Type
Object
35.1.5.4. Content Type
- application/json
35.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.5.6. Samples
35.1.6. TestImageIntegration
POST /v1/imageintegrations/test
TestImageIntegration checks if the given image integration is correctly configured, without using stored credential reconciliation.
35.1.6.1. Description
35.1.6.2. Parameters
35.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.6.3. Return Type
Object
35.1.6.4. Content Type
- application/json
35.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.6.6. Samples
35.1.7. TestUpdatedImageIntegration
POST /v1/imageintegrations/test/updated
TestUpdatedImageIntegration checks if the given image integration is correctly configured, with optional stored credential reconciliation.
35.1.7.1. Description
35.1.7.2. Parameters
35.1.7.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.7.3. Return Type
Object
35.1.7.4. Content Type
- application/json
35.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.7.6. Samples
35.1.8. UpdateImageIntegration
PATCH /v1/imageintegrations/{config.id}
UpdateImageIntegration modifies a given image integration, with optional stored credential reconciliation.
35.1.8.1. Description
35.1.8.2. Parameters
35.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| config.id | X | null |
35.1.8.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
35.1.8.3. Return Type
Object
35.1.8.4. Content Type
- application/json
35.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
35.1.8.6. Samples
Chapter 36. Image Service
36.1. Image Service
36.1.1. CountImages
GET /v1/imagescount
CountImages returns a count of images that match the input query.
36.1.1.1. Description
36.1.1.2. Parameters
36.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
36.1.1.3. Return Type
36.1.1.4. Content Type
- application/json
36.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.1.6. Samples
36.1.2. DeleteImages
DELETE /v1/images
DeleteImage removes the images based on a query
36.1.2.1. Description
36.1.2.2. Parameters
36.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null | ||
| confirm | - | null |
36.1.2.3. Return Type
36.1.2.4. Content Type
- application/json
36.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.2.6. Samples
36.1.3. ExportImages
GET /v1/export/images
36.1.3.1. Description
36.1.3.2. Parameters
36.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
36.1.3.3. Return Type
Stream result of v1ExportImageResponse.
36.1.3.4. Content Type
- application/json
36.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | Stream result of v1ExportImageResponse. |
| 0 | An unexpected error response. |
36.1.3.6. Samples
36.1.4. GetImage
GET /v1/images/{id}
GetImage returns the image given its ID.
36.1.4.1. Description
36.1.4.2. Parameters
36.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
36.1.4.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| includeSnoozed | - | null | ||
| stripDescription | - | null |
36.1.4.3. Return Type
36.1.4.4. Content Type
- application/json
36.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.4.6. Samples
36.1.5. GetWatchedImages
GET /v1/watchedimages
GetWatchedImages returns the list of image names that are currently being watched.
36.1.5.1. Description
36.1.5.2. Parameters
36.1.5.3. Return Type
36.1.5.4. Content Type
- application/json
36.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.5.6. Samples
36.1.6. InvalidateScanAndRegistryCaches
GET /v1/images/cache/invalidate
InvalidateScanAndRegistryCaches removes the image metadata cache.
36.1.6.1. Description
36.1.6.2. Parameters
36.1.6.3. Return Type
Object
36.1.6.4. Content Type
- application/json
36.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
36.1.6.6. Samples
36.1.7. ListImages
GET /v1/images
ListImages returns all the images that match the input query.
36.1.7.1. Description
36.1.7.2. Parameters
36.1.7.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
36.1.7.3. Return Type
36.1.7.4. Content Type
- application/json
36.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.7.6. Samples
36.1.8. ScanImage
POST /v1/images/scan
ScanImage scans a single image and returns the result
36.1.8.1. Description
36.1.8.2. Parameters
36.1.8.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
36.1.8.3. Return Type
36.1.8.4. Content Type
- application/json
36.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.8.6. Samples
36.1.9. UnwatchImage
DELETE /v1/watchedimages
UnwatchImage marks an image name to no longer be watched. It returns successfully if the image is no longer being watched after the call, irrespective of whether the image was already being watched.
36.1.9.1. Description
36.1.9.2. Parameters
36.1.9.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name | The name of the image to unwatch. Should match the name of a previously watched image. | - | null |
36.1.9.3. Return Type
Object
36.1.9.4. Content Type
- application/json
36.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
36.1.9.6. Samples
36.1.10. WatchImage
POST /v1/watchedimages
WatchImage marks an image name as to be watched.
36.1.10.1. Description
36.1.10.2. Parameters
36.1.10.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
36.1.10.3. Return Type
36.1.10.4. Content Type
- application/json
36.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
36.1.10.6. Samples
Chapter 37. Integration Health Service
37.1. Integration Health Service
37.1.1. GetBackupPlugins
GET /v1/integrationhealth/externalbackups
37.1.1.1. Description
37.1.1.2. Parameters
37.1.1.3. Return Type
37.1.1.4. Content Type
- application/json
37.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
37.1.1.6. Samples
37.1.2. GetDeclarativeConfigs
GET /v1/integrationhealth/declarativeconfigs
37.1.2.1. Description
37.1.2.2. Parameters
37.1.2.3. Return Type
37.1.2.4. Content Type
- application/json
37.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
37.1.2.6. Samples
37.1.3. GetImageIntegrations
GET /v1/integrationhealth/imageintegrations
37.1.3.1. Description
37.1.3.2. Parameters
37.1.3.3. Return Type
37.1.3.4. Content Type
- application/json
37.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
37.1.3.6. Samples
37.1.4. GetNotifiers
GET /v1/integrationhealth/notifiers
37.1.4.1. Description
37.1.4.2. Parameters
37.1.4.3. Return Type
37.1.4.4. Content Type
- application/json
37.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
37.1.4.6. Samples
37.1.5. GetVulnDefinitionsInfo
GET /v1/integrationhealth/vulndefinitions
37.1.5.1. Description
37.1.5.2. Parameters
37.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| component | - | SCANNER |
37.1.5.3. Return Type
37.1.5.4. Content Type
- application/json
37.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
37.1.5.6. Samples
Chapter 38. Listening Endpoints Service
38.1. Listening Endpoints Service
38.1.1. GetListeningEndpoints
GET /v1/listening_endpoints/deployment/{deploymentId}
GetListeningEndpoints returns the listening endpoints and the processes that opened them for a given deployment
38.1.1.1. Description
38.1.1.2. Parameters
38.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
38.1.1.3. Return Type
38.1.1.4. Content Type
- application/json
38.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
38.1.1.6. Samples
Chapter 39. Metadata Service
39.1. Metadata Service
39.1.1. GetCentralCapabilities
GET /v1/central-capabilities
39.1.1.1. Description
39.1.1.2. Parameters
39.1.1.3. Return Type
39.1.1.4. Content Type
- application/json
39.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.1.6. Samples
39.1.2. GetDatabaseBackupStatus
GET /v1/backup/status
39.1.2.1. Description
39.1.2.2. Parameters
39.1.2.3. Return Type
39.1.2.4. Content Type
- application/json
39.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.2.6. Samples
39.1.3. GetDatabaseStatus
GET /v1/database/status
39.1.3.1. Description
39.1.3.2. Parameters
39.1.3.3. Return Type
39.1.3.4. Content Type
- application/json
39.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.3.6. Samples
39.1.4. GetMetadata
GET /v1/metadata
39.1.4.1. Description
39.1.4.2. Parameters
39.1.4.3. Return Type
39.1.4.4. Content Type
- application/json
39.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.4.6. Samples
39.1.5. TLSChallenge
GET /v1/tls-challenge
TLSChallenge
39.1.5.1. Description
Returns all trusted CAs, i.e., secret/additional-ca and Central’s cert chain. This is necessary if Central is running behind a load balancer with self-signed certificates. Does not require authentication.
39.1.5.2. Parameters
39.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| challengeToken | generated challenge token by the service asking for TLS certs | - | null |
39.1.5.3. Return Type
39.1.5.4. Content Type
- application/json
39.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
39.1.5.6. Samples
Chapter 40. Mitre Attack Service
40.1. Mitre Attack Service
40.1.1. GetMitreAttackVector
GET /v1/mitreattackvectors/{id}
GetMitreAttackVector returns the full MITRE ATT&CK vector for a tactic with all its techniques.
40.1.1.1. Description
40.1.1.2. Parameters
40.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
40.1.1.3. Return Type
40.1.1.4. Content Type
- application/json
40.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
40.1.1.6. Samples
40.1.2. ListMitreAttackVectors
GET /v1/mitreattackvectors
ListMitreAttackVectors returns all MITRE ATT&CK vectors.
40.1.2.1. Description
40.1.2.2. Parameters
40.1.2.3. Return Type
40.1.2.4. Content Type
- application/json
40.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
40.1.2.6. Samples
Chapter 41. Namespace Service
41.1. Namespace Service
41.1.1. GetNamespace
GET /v1/namespaces/{id}
41.1.1.1. Description
41.1.1.2. Parameters
41.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
41.1.1.3. Return Type
41.1.1.4. Content Type
- application/json
41.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
41.1.1.6. Samples
41.1.2. GetNamespaces
GET /v1/namespaces
41.1.2.1. Description
41.1.2.2. Parameters
41.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
41.1.2.3. Return Type
41.1.2.4. Content Type
- application/json
41.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
41.1.2.6. Samples
Chapter 42. Network Baseline Service
42.1. Network Baseline Service
42.1.1. GetNetworkBaseline
GET /v1/networkbaseline/{id}
42.1.1.1. Description
42.1.1.2. Parameters
42.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
42.1.1.3. Return Type
42.1.1.4. Content Type
- application/json
42.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
42.1.1.6. Samples
42.1.2. GetNetworkBaselineStatusForFlows
POST /v1/networkbaseline/{deploymentId}/status
42.1.2.1. Description
42.1.2.2. Parameters
42.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
42.1.2.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
42.1.2.3. Return Type
42.1.2.4. Content Type
- application/json
42.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
42.1.2.6. Samples
42.1.3. LockNetworkBaseline
PATCH /v1/networkbaseline/{id}/lock
42.1.3.1. Description
42.1.3.2. Parameters
42.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
42.1.3.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body |
| X |
42.1.3.3. Return Type
Object
42.1.3.4. Content Type
- application/json
42.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
42.1.3.6. Samples
42.1.4. ModifyBaselineStatusForPeers
PATCH /v1/networkbaseline/{deploymentId}/peers
42.1.4.1. Description
42.1.4.2. Parameters
42.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
42.1.4.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
42.1.4.3. Return Type
Object
42.1.4.4. Content Type
- application/json
42.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
42.1.4.6. Samples
42.1.5. UnlockNetworkBaseline
PATCH /v1/networkbaseline/{id}/unlock
42.1.5.1. Description
42.1.5.2. Parameters
42.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
42.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body |
| X |
42.1.5.3. Return Type
Object
42.1.5.4. Content Type
- application/json
42.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
42.1.5.6. Samples
Chapter 43. Network Graph Service
43.1. Network Graph Service
43.1.1. CreateExternalNetworkEntity
POST /v1/networkgraph/cluster/{clusterId}/externalentities
43.1.1.1. Description
43.1.1.2. Parameters
43.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
43.1.1.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
43.1.1.3. Return Type
43.1.1.4. Content Type
- application/json
43.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.1.6. Samples
43.1.2. DeleteExternalNetworkEntity
DELETE /v1/networkgraph/externalentities/{id}
43.1.2.1. Description
43.1.2.2. Parameters
43.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
43.1.2.3. Return Type
Object
43.1.2.4. Content Type
- application/json
43.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
43.1.2.6. Samples
43.1.3. GetExternalNetworkEntities
GET /v1/networkgraph/cluster/{clusterId}/externalentities
43.1.3.1. Description
43.1.3.2. Parameters
43.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
43.1.3.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null |
43.1.3.3. Return Type
43.1.3.4. Content Type
- application/json
43.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.3.6. Samples
43.1.4. GetExternalNetworkFlows
GET /v1/networkgraph/cluster/{clusterId}/externalentities/flows/{deploymentId}
43.1.4.1. Description
43.1.4.2. Parameters
43.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null | ||
| deploymentId | X | null |
43.1.4.3. Return Type
43.1.4.4. Content Type
- application/json
43.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.4.6. Samples
43.1.5. GetNetworkGraph
GET /v1/networkgraph/cluster/{clusterId}
43.1.5.1. Description
43.1.5.2. Parameters
43.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
43.1.5.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| since | - | null | ||
| includePorts | - | null | ||
| scope.query | - | null | ||
| includePolicies | - | null |
43.1.5.3. Return Type
43.1.5.4. Content Type
- application/json
43.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.5.6. Samples
43.1.6. GetNetworkGraphConfig
GET /v1/networkgraph/config
43.1.6.1. Description
43.1.6.2. Parameters
43.1.6.3. Return Type
43.1.6.4. Content Type
- application/json
43.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.6.6. Samples
43.1.7. PatchExternalNetworkEntity
PATCH /v1/networkgraph/externalentities/{id}
43.1.7.1. Description
43.1.7.2. Parameters
43.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
43.1.7.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
43.1.7.3. Return Type
43.1.7.4. Content Type
- application/json
43.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.7.6. Samples
43.1.8. PutNetworkGraphConfig
PUT /v1/networkgraph/config
43.1.8.1. Description
43.1.8.2. Parameters
43.1.8.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
43.1.8.3. Return Type
43.1.8.4. Content Type
- application/json
43.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
43.1.8.6. Samples
Chapter 44. Network Policy Service
44.1. Network Policy Service
44.1.1. ApplyNetworkPolicy
POST /v1/networkpolicies/apply/{clusterId}
44.1.1.1. Description
44.1.1.2. Parameters
44.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.1.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| modification | X |
44.1.1.3. Return Type
Object
44.1.1.4. Content Type
- application/json
44.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
44.1.1.6. Samples
44.1.2. ApplyNetworkPolicyYamlForDeployment
POST /v1/networkpolicies/apply/deployment/{deploymentId}
44.1.2.1. Description
44.1.2.2. Parameters
44.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
44.1.2.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
44.1.2.3. Return Type
Object
44.1.2.4. Content Type
- application/json
44.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
44.1.2.6. Samples
44.1.3. GenerateNetworkPolicies
GET /v1/networkpolicies/generate/{clusterId}
44.1.3.1. Description
44.1.3.2. Parameters
44.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.3.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| deleteExisting | - NONE: Do not delete any existing network policies. - GENERATED_ONLY: Delete any existing auto-generated network policies. - ALL: Delete all existing network policies in the respective namespace. | - | UNKNOWN | |
| networkDataSince | - | null | ||
| includePorts | - | null |
44.1.3.3. Return Type
44.1.3.4. Content Type
- application/json
44.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.3.6. Samples
44.1.4. GetAllowedPeersFromCurrentPolicyForDeployment
GET /v1/networkpolicies/allowedpeers/{id}
44.1.4.1. Description
44.1.4.2. Parameters
44.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
44.1.4.3. Return Type
44.1.4.4. Content Type
- application/json
44.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.4.6. Samples
44.1.5. GetBaselineGeneratedNetworkPolicyForDeployment
POST /v1/networkpolicies/generate/baseline/{deploymentId}
44.1.5.1. Description
44.1.5.2. Parameters
44.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
44.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | NetworkPolicyServiceGetBaselineGeneratedNetworkPolicyForDeploymentBody | X |
44.1.5.3. Return Type
44.1.5.4. Content Type
- application/json
44.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.5.6. Samples
44.1.6. GetDiffFlowsBetweenPolicyAndBaselineForDeployment
GET /v1/networkpolicies/baselinecomparison/{id}
44.1.6.1. Description
44.1.6.2. Parameters
44.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
44.1.6.3. Return Type
44.1.6.4. Content Type
- application/json
44.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.6.6. Samples
44.1.7. GetDiffFlowsFromUndoModificationForDeployment
GET /v1/networkpolicies/undobaselinecomparison/{id}
44.1.7.1. Description
44.1.7.2. Parameters
44.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
44.1.7.3. Return Type
44.1.7.4. Content Type
- application/json
44.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.7.6. Samples
44.1.8. GetNetworkGraph
GET /v1/networkpolicies/cluster/{clusterId}
44.1.8.1. Description
44.1.8.2. Parameters
44.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.8.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| includePorts | If set to true, include port-level information in the network policy graph. | - | null | |
| scope.query | - | null |
44.1.8.3. Return Type
44.1.8.4. Content Type
- application/json
44.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.8.6. Samples
44.1.9. GetNetworkGraphEpoch
GET /v1/networkpolicies/graph/epoch
44.1.9.1. Description
44.1.9.2. Parameters
44.1.9.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | - | null |
44.1.9.3. Return Type
44.1.9.4. Content Type
- application/json
44.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.9.6. Samples
44.1.10. GetNetworkPolicies
GET /v1/networkpolicies
44.1.10.1. Description
44.1.10.2. Parameters
44.1.10.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | - | null | ||
| deploymentQuery | - | null | ||
| namespace | - | null |
44.1.10.3. Return Type
44.1.10.4. Content Type
- application/json
44.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.10.6. Samples
44.1.11. GetNetworkPolicy
GET /v1/networkpolicies/{id}
44.1.11.1. Description
44.1.11.2. Parameters
44.1.11.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
44.1.11.3. Return Type
44.1.11.4. Content Type
- application/json
44.1.11.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.11.6. Samples
44.1.12. GetUndoModification
GET /v1/networkpolicies/undo/{clusterId}
44.1.12.1. Description
44.1.12.2. Parameters
44.1.12.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.12.3. Return Type
44.1.12.4. Content Type
- application/json
44.1.12.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.12.6. Samples
44.1.13. GetUndoModificationForDeployment
GET /v1/networkpolicies/undo/deployment/{id}
44.1.13.1. Description
44.1.13.2. Parameters
44.1.13.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
44.1.13.3. Return Type
44.1.13.4. Content Type
- application/json
44.1.13.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.13.6. Samples
44.1.14. SendNetworkPolicyYAML
POST /v1/networkpolicies/simulate/{clusterId}/notify
44.1.14.1. Description
44.1.14.2. Parameters
44.1.14.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.14.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| modification | X |
44.1.14.2.3. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| notifierIds |
| - | null |
44.1.14.3. Return Type
Object
44.1.14.4. Content Type
- application/json
44.1.14.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
44.1.14.6. Samples
44.1.15. SimulateNetworkGraph
POST /v1/networkpolicies/simulate/{clusterId}
44.1.15.1. Description
44.1.15.2. Parameters
44.1.15.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.15.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| modification | X |
44.1.15.2.3. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| includePorts | If set to true, include port-level information in the network policy graph. | - | null | |
| includeNodeDiff | - | null | ||
| scope.query | - | null |
44.1.15.3. Return Type
44.1.15.4. Content Type
- application/json
44.1.15.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
44.1.15.6. Samples
Chapter 45. Node CVEService
45.1. Node C V E Service
45.1.1. SuppressCVEs
PATCH /v1/nodecves/suppress
SuppressCVE suppresses node cves.
45.1.1.1. Description
45.1.1.2. Parameters
45.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
45.1.1.3. Return Type
Object
45.1.1.4. Content Type
- application/json
45.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
45.1.1.6. Samples
45.1.2. UnsuppressCVEs
PATCH /v1/nodecves/unsuppress
UnsuppressCVE unsuppresses node cves.
45.1.2.1. Description
45.1.2.2. Parameters
45.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
45.1.2.3. Return Type
Object
45.1.2.4. Content Type
- application/json
45.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
45.1.2.6. Samples
Chapter 46. Node Service
46.1. Node Service
46.1.1. ExportNodes
GET /v1/export/nodes
46.1.1.1. Description
46.1.1.2. Parameters
46.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
46.1.1.3. Return Type
Stream result of v1ExportNodeResponse.
46.1.1.4. Content Type
- application/json
46.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | Stream result of v1ExportNodeResponse. |
| 0 | An unexpected error response. |
46.1.1.6. Samples
46.1.2. GetNode
GET /v1/nodes/{clusterId}/{nodeId}
46.1.2.1. Description
46.1.2.2. Parameters
46.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null | ||
| nodeId | X | null |
46.1.2.3. Return Type
46.1.2.4. Content Type
- application/json
46.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
46.1.2.6. Samples
46.1.3. ListNodes
GET /v1/nodes/{clusterId}
46.1.3.1. Description
46.1.3.2. Parameters
46.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
46.1.3.3. Return Type
46.1.3.4. Content Type
- application/json
46.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
46.1.3.6. Samples
Chapter 47. Notifier Service
47.1. Notifier Service
47.1.1. DeleteNotifier
DELETE /v1/notifiers/{id}
DeleteNotifier removes a notifier configuration given its ID.
47.1.1.1. Description
47.1.1.2. Parameters
47.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
47.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| force | - | null |
47.1.1.3. Return Type
Object
47.1.1.4. Content Type
- application/json
47.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
47.1.1.6. Samples
47.1.2. GetNotifier
GET /v1/notifiers/{id}
GetNotifier returns the notifier configuration given its ID.
47.1.2.1. Description
47.1.2.2. Parameters
47.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
47.1.2.3. Return Type
47.1.2.4. Content Type
- application/json
47.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
47.1.2.6. Samples
47.1.3. GetNotifiers
GET /v1/notifiers
GetNotifiers returns all notifier configurations.
47.1.3.1. Description
47.1.3.2. Parameters
47.1.3.3. Return Type
47.1.3.4. Content Type
- application/json
47.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
47.1.3.6. Samples
47.1.4. PostNotifier
POST /v1/notifiers
PostNotifier creates a notifier configuration.
47.1.4.1. Description
47.1.4.2. Parameters
47.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
47.1.4.3. Return Type
47.1.4.4. Content Type
- application/json
47.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
47.1.4.6. Samples
47.1.5. PutNotifier
PUT /v1/notifiers/{id}
PutNotifier modifies a given notifier, without using stored credential reconciliation.
47.1.5.1. Description
47.1.5.2. Parameters
47.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
47.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
47.1.5.3. Return Type
Object
47.1.5.4. Content Type
- application/json
47.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
47.1.5.6. Samples
47.1.6. TestNotifier
POST /v1/notifiers/test
TestNotifier checks if a notifier is correctly configured.
47.1.6.1. Description
47.1.6.2. Parameters
47.1.6.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
47.1.6.3. Return Type
Object
47.1.6.4. Content Type
- application/json
47.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
47.1.6.6. Samples
47.1.7. TestUpdatedNotifier
POST /v1/notifiers/test/updated
TestUpdatedNotifier checks if the given notifier is correctly configured, with optional stored credential reconciliation.
47.1.7.1. Description
47.1.7.2. Parameters
47.1.7.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
47.1.7.3. Return Type
Object
47.1.7.4. Content Type
- application/json
47.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
47.1.7.6. Samples
47.1.8. UpdateNotifier
PATCH /v1/notifiers/{notifier.id}
UpdateNotifier modifies a given notifier, with optional stored credential reconciliation.
47.1.8.1. Description
47.1.8.2. Parameters
47.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| notifier.id | X | null |
47.1.8.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
47.1.8.3. Return Type
Object
47.1.8.4. Content Type
- application/json
47.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
47.1.8.6. Samples
Chapter 48. Ping Service
48.1. Ping Service
48.1.1. Ping
GET /v1/ping
48.1.1.1. Description
48.1.1.2. Parameters
48.1.1.3. Return Type
48.1.1.4. Content Type
- application/json
48.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
48.1.1.6. Samples
Chapter 49. Pod Service
49.1. Pod Service
49.1.1. ExportPods
GET /v1/export/pods
49.1.1.1. Description
49.1.1.2. Parameters
49.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| timeout | - | null | ||
| query | - | null |
49.1.1.3. Return Type
Stream result of v1ExportPodResponse.
49.1.1.4. Content Type
- application/json
49.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response.(streaming responses) | Stream result of v1ExportPodResponse. |
| 0 | An unexpected error response. |
49.1.1.6. Samples
49.1.2. GetPods
GET /v1/pods
GetPods returns the pods.
49.1.2.1. Description
49.1.2.2. Parameters
49.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
49.1.2.3. Return Type
49.1.2.4. Content Type
- application/json
49.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
49.1.2.6. Samples
Chapter 50. Policy Category Service
50.1. Policy Category Service
50.1.1. DeletePolicyCategory
DELETE /v1/policycategories/{id}
DeletePolicyCategory removes the given policy category.
50.1.1.1. Description
50.1.1.2. Parameters
50.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.1.1.3. Return Type
Object
50.1.1.4. Content Type
- application/json
50.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
50.1.1.6. Samples
50.1.2. GetPolicyCategories
GET /v1/policycategories
GetPolicyCategories returns the list of policy categories
50.1.2.1. Description
50.1.2.2. Parameters
50.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
50.1.2.3. Return Type
50.1.2.4. Content Type
- application/json
50.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.2.6. Samples
50.1.3. GetPolicyCategory
GET /v1/policycategories/{id}
GetPolicyCategory returns the requested policy category by ID.
50.1.3.1. Description
50.1.3.2. Parameters
50.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
50.1.3.3. Return Type
50.1.3.4. Content Type
- application/json
50.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.3.6. Samples
50.1.4. PostPolicyCategory
POST /v1/policycategories
PostPolicyCategory creates a new policy category
50.1.4.1. Description
50.1.4.2. Parameters
50.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| policyCategory | X |
50.1.4.3. Return Type
50.1.4.4. Content Type
- application/json
50.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.4.6. Samples
50.1.5. RenamePolicyCategory
PUT /v1/policycategories
RenamePolicyCategory renames the given policy category.
50.1.5.1. Description
50.1.5.2. Parameters
50.1.5.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
50.1.5.3. Return Type
50.1.5.4. Content Type
- application/json
50.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
50.1.5.6. Samples
Chapter 51. Policy Service
51.1. Policy Service
51.1.1. CancelDryRunJob
DELETE /v1/policies/dryrunjob/{jobId}
51.1.1.1. Description
51.1.1.2. Parameters
51.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| jobId | X | null |
51.1.1.3. Return Type
Object
51.1.1.4. Content Type
- application/json
51.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.1.6. Samples
51.1.2. DeletePolicy
DELETE /v1/policies/{id}
DeletePolicy removes a policy by ID.
51.1.2.1. Description
51.1.2.2. Parameters
51.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
51.1.2.3. Return Type
Object
51.1.2.4. Content Type
- application/json
51.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.2.6. Samples
51.1.3. DryRunPolicy
POST /v1/policies/dryrun
DryRunPolicy evaluates the given policy and returns any alerts without creating the policy.
51.1.3.1. Description
51.1.3.2. Parameters
51.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.3.3. Return Type
51.1.3.4. Content Type
- application/json
51.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.3.6. Samples
51.1.4. EnableDisablePolicyNotification
PATCH /v1/policies/{policyId}/notifiers
EnableDisablePolicyNotification enables or disables notifications for a policy by ID.
51.1.4.1. Description
51.1.4.2. Parameters
51.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| policyId | X | null |
51.1.4.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.4.3. Return Type
Object
51.1.4.4. Content Type
- application/json
51.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.4.6. Samples
51.1.5. ExportPolicies
POST /v1/policies/export
ExportPolicies takes a list of policy IDs and returns either the entire list of policies or an error message
51.1.5.1. Description
51.1.5.2. Parameters
51.1.5.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.5.3. Return Type
51.1.5.4. Content Type
- application/json
51.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.5.6. Samples
51.1.6. GetPolicy
GET /v1/policies/{id}
GetPolicy returns the requested policy by ID.
51.1.6.1. Description
51.1.6.2. Parameters
51.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
51.1.6.3. Return Type
51.1.6.4. Content Type
- application/json
51.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.6.6. Samples
51.1.7. GetPolicyCategories
GET /v1/policyCategories
GetPolicyCategories returns the policy categories.
51.1.7.1. Description
51.1.7.2. Parameters
51.1.7.3. Return Type
51.1.7.4. Content Type
- application/json
51.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.7.6. Samples
51.1.8. GetPolicyMitreVectors
GET /v1/policies/{id}/mitrevectors
GetMitreVectorsForPolicy returns the requested policy by ID.
51.1.8.1. Description
51.1.8.2. Parameters
51.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
51.1.8.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| options.excludePolicy | If set to true, policy is excluded from the response. | - | null |
51.1.8.3. Return Type
51.1.8.4. Content Type
- application/json
51.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.8.6. Samples
51.1.9. ImportPolicies
POST /v1/policies/import
ImportPolicies accepts a list of Policies and returns a list of the policies which could not be imported
51.1.9.1. Description
51.1.9.2. Parameters
51.1.9.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.9.3. Return Type
51.1.9.4. Content Type
- application/json
51.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.9.6. Samples
51.1.10. ListPolicies
GET /v1/policies
ListPolicies returns the list of policies.
51.1.10.1. Description
51.1.10.2. Parameters
51.1.10.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
51.1.10.3. Return Type
51.1.10.4. Content Type
- application/json
51.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.10.6. Samples
51.1.11. PatchPolicy
PATCH /v1/policies/{id}
PatchPolicy edits an existing policy.
51.1.11.1. Description
51.1.11.2. Parameters
51.1.11.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
51.1.11.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.11.3. Return Type
Object
51.1.11.4. Content Type
- application/json
51.1.11.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.11.6. Samples
51.1.12. PolicyFromSearch
POST /v1/policies/from-search
51.1.12.1. Description
51.1.12.2. Parameters
51.1.12.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.12.3. Return Type
51.1.12.4. Content Type
- application/json
51.1.12.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.12.6. Samples
51.1.13. PostPolicy
POST /v1/policies
PostPolicy creates a new policy.
51.1.13.1. Description
51.1.13.2. Parameters
51.1.13.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| policy | X |
51.1.13.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| enableStrictValidation | - | null |
51.1.13.3. Return Type
51.1.13.4. Content Type
- application/json
51.1.13.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.13.6. Samples
51.1.14. PutPolicy
PUT /v1/policies/{id}
PutPolicy modifies an existing policy.
51.1.14.1. Description
51.1.14.2. Parameters
51.1.14.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
51.1.14.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.14.3. Return Type
Object
51.1.14.4. Content Type
- application/json
51.1.14.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.14.6. Samples
51.1.15. QueryDryRunJobStatus
GET /v1/policies/dryrunjob/{jobId}
51.1.15.1. Description
51.1.15.2. Parameters
51.1.15.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| jobId | X | null |
51.1.15.3. Return Type
51.1.15.4. Content Type
- application/json
51.1.15.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.15.6. Samples
51.1.16. ReassessPolicies
POST /v1/policies/reassess
ReassessPolicies reevaluates all the policies.
51.1.16.1. Description
51.1.16.2. Parameters
51.1.16.3. Return Type
Object
51.1.16.4. Content Type
- application/json
51.1.16.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
51.1.16.6. Samples
51.1.17. SubmitDryRunPolicyJob
POST /v1/policies/dryrunjob
51.1.17.1. Description
51.1.17.2. Parameters
51.1.17.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
51.1.17.3. Return Type
51.1.17.4. Content Type
- application/json
51.1.17.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
51.1.17.6. Samples
Chapter 52. Probe Upload Service
52.1. Probe Upload Service
52.1.1. GetExistingProbes
POST /v1/probeupload/getexisting
52.1.1.1. Description
52.1.1.2. Parameters
52.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| filesToCheck |
| - | null |
52.1.1.3. Return Type
52.1.1.4. Content Type
- application/json
52.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
52.1.1.6. Samples
Chapter 53. Process Baseline Service
53.1. Process Baseline Service
53.1.1. DeleteProcessBaselines
DELETE /v1/processbaselines
DeleteProcessBaselines deletes baselines.
53.1.1.1. Description
53.1.1.2. Parameters
53.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| confirm | - | null |
53.1.1.3. Return Type
53.1.1.4. Content Type
- application/json
53.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
53.1.1.6. Samples
53.1.2. GetProcessBaseline
GET /v1/processbaselines/key
GetProcessBaselineById returns the single process baseline referenced by the given ID.
53.1.2.1. Description
53.1.2.2. Parameters
53.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| key.deploymentId | The idea is for the keys to be flexible. Only certain combinations of these will be supported. | - | null | |
| key.containerName | - | null | ||
| key.clusterId | - | null | ||
| key.namespace | - | null |
53.1.2.3. Return Type
53.1.2.4. Content Type
- application/json
53.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
53.1.2.6. Samples
53.1.3. LockProcessBaselines
PUT /v1/processbaselines/lock
LockProcessBaselines accepts a list of baseline IDs, locks those baselines, and returns the updated baseline objects.
53.1.3.1. Description
53.1.3.2. Parameters
53.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
53.1.3.3. Return Type
53.1.3.4. Content Type
- application/json
53.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
53.1.3.6. Samples
53.1.4. UpdateProcessBaselines
PUT /v1/processbaselines
AddToProcessBaselines adds a list of process names to each of a list of process baselines.
53.1.4.1. Description
53.1.4.2. Parameters
53.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
53.1.4.3. Return Type
53.1.4.4. Content Type
- application/json
53.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
53.1.4.6. Samples
Chapter 54. Process Service
54.1. Process Service
54.1.1. CountProcesses
GET /v1/processcount
CountProcesses returns the count of processes.
54.1.1.1. Description
54.1.1.2. Parameters
54.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
54.1.1.3. Return Type
54.1.1.4. Content Type
- application/json
54.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.1.6. Samples
54.1.2. GetGroupedProcessByDeployment
GET /v1/processes/deployment/{deploymentId}/grouped
GetGroupedProcessByDeployment returns all the processes executed grouped by deployment.
54.1.2.1. Description
54.1.2.2. Parameters
54.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.2.3. Return Type
54.1.2.4. Content Type
- application/json
54.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.2.6. Samples
54.1.3. GetGroupedProcessByDeploymentAndContainer
GET /v1/processes/deployment/{deploymentId}/grouped/container
GetGroupedProcessByDeploymentAndContainer returns all the processes executed grouped by deployment and container.
54.1.3.1. Description
54.1.3.2. Parameters
54.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.3.3. Return Type
54.1.3.4. Content Type
- application/json
54.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.3.6. Samples
54.1.4. GetProcessesByDeployment
GET /v1/processes/deployment/{deploymentId}
GetProcessesByDeployment returns the processes executed in the given deployment.
54.1.4.1. Description
54.1.4.2. Parameters
54.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| deploymentId | X | null |
54.1.4.3. Return Type
54.1.4.4. Content Type
- application/json
54.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
54.1.4.6. Samples
Chapter 55. Rbac Service
55.1. Rbac Service
55.1.1. GetRole
GET /v1/rbac/roles/{id}
55.1.1.1. Description
55.1.1.2. Parameters
55.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
55.1.1.3. Return Type
55.1.1.4. Content Type
- application/json
55.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.1.6. Samples
55.1.2. GetRoleBinding
GET /v1/rbac/bindings/{id}
55.1.2.1. Description
55.1.2.2. Parameters
55.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
55.1.2.3. Return Type
55.1.2.4. Content Type
- application/json
55.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.2.6. Samples
55.1.3. GetSubject
GET /v1/rbac/subject/{id}
Subjects served from this API are Groups and Users only. Id in this case is the Name field, since for users and groups, that is unique, and subjects do not have IDs.
55.1.3.1. Description
55.1.3.2. Parameters
55.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
55.1.3.3. Return Type
55.1.3.4. Content Type
- application/json
55.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.3.6. Samples
55.1.4. ListRoleBindings
GET /v1/rbac/bindings
55.1.4.1. Description
55.1.4.2. Parameters
55.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
55.1.4.3. Return Type
55.1.4.4. Content Type
- application/json
55.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.4.6. Samples
55.1.5. ListRoles
GET /v1/rbac/roles
55.1.5.1. Description
55.1.5.2. Parameters
55.1.5.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
55.1.5.3. Return Type
55.1.5.4. Content Type
- application/json
55.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.5.6. Samples
55.1.6. ListSubjects
GET /v1/rbac/subjects
55.1.6.1. Description
55.1.6.2. Parameters
55.1.6.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
55.1.6.3. Return Type
55.1.6.4. Content Type
- application/json
55.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
55.1.6.6. Samples
Chapter 56. Report Configuration Service
56.1. Report Configuration Service
56.1.1. CountReportConfigurations
GET /v1/report-configurations-count
CountReportConfigurations returns the number of report configurations.
56.1.1.1. Description
56.1.1.2. Parameters
56.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
56.1.1.3. Return Type
56.1.1.4. Content Type
- application/json
56.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
56.1.1.6. Samples
56.1.2. DeleteReportConfiguration
DELETE /v1/report/configurations/{id}
DeleteReportConfiguration removes a report configuration given its id
56.1.2.1. Description
56.1.2.2. Parameters
56.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
56.1.2.3. Return Type
Object
56.1.2.4. Content Type
- application/json
56.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
56.1.2.6. Samples
56.1.3. GetReportConfiguration
GET /v1/report/configurations/{id}
56.1.3.1. Description
56.1.3.2. Parameters
56.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
56.1.3.3. Return Type
56.1.3.4. Content Type
- application/json
56.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
56.1.3.6. Samples
56.1.4. GetReportConfigurations
GET /v1/report/configurations
56.1.4.1. Description
56.1.4.2. Parameters
56.1.4.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
56.1.4.3. Return Type
56.1.4.4. Content Type
- application/json
56.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
56.1.4.6. Samples
56.1.5. PostReportConfiguration
POST /v1/report/configurations
PostReportConfiguration creates a report configuration
56.1.5.1. Description
56.1.5.2. Parameters
56.1.5.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
56.1.5.3. Return Type
56.1.5.4. Content Type
- application/json
56.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
56.1.5.6. Samples
56.1.6. UpdateReportConfiguration
PUT /v1/report/configurations/{id}
UpdateReportConfiguration updates a report configuration
56.1.6.1. Description
56.1.6.2. Parameters
56.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
56.1.6.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
56.1.6.3. Return Type
Object
56.1.6.4. Content Type
- application/json
56.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
56.1.6.6. Samples
Chapter 57. Report Service
57.1. Report Service
57.1.1. CancelReport
DELETE /v2/reports/jobs/{id}/cancel
Cancels a queued report job for the given report id. If the job is not active, it is a noop. If a report is already being prepared, it won’t be cancelled.
57.1.1.1. Description
57.1.1.2. Parameters
57.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.1.3. Return Type
Object
57.1.1.4. Content Type
- application/json
57.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
57.1.1.6. Samples
57.1.2. CountReportConfigurations
GET /v2/reports/configuration-count
CountReportConfigurations returns the number of report configurations.
57.1.2.1. Description
57.1.2.2. Parameters
57.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
57.1.2.3. Return Type
57.1.2.4. Content Type
- application/json
57.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.2.6. Samples
57.1.3. DeleteReport
DELETE /v2/reports/jobs/{id}/delete
Deletes a generated report for the given report id
57.1.3.1. Description
57.1.3.2. Parameters
57.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.3.3. Return Type
Object
57.1.3.4. Content Type
- application/json
57.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
57.1.3.6. Samples
57.1.4. DeleteReportConfiguration
DELETE /v2/reports/configurations/{id}
DeleteReportConfiguration removes the report configuration with given ID
57.1.4.1. Description
57.1.4.2. Parameters
57.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.4.3. Return Type
Object
57.1.4.4. Content Type
- application/json
57.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
57.1.4.6. Samples
57.1.5. GetMyReportHistory
GET /v2/reports/configurations/{id}/my-history
GetMyReportHistory returns the requester’s report job history for a report configuration with the specified ID.
57.1.5.1. Description
57.1.5.2. Parameters
57.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.5.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
57.1.5.3. Return Type
57.1.5.4. Content Type
- application/json
57.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.5.6. Samples
57.1.6. GetReportConfiguration
GET /v2/reports/configurations/{id}
GetReportConfiguration returns the report configuration with given ID
57.1.6.1. Description
57.1.6.2. Parameters
57.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.6.3. Return Type
57.1.6.4. Content Type
- application/json
57.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.6.6. Samples
57.1.7. GetReportHistory
GET /v2/reports/configurations/{id}/history
GetReportHistory returns the full report job history for a report configuration with the specified ID.
57.1.7.1. Description
57.1.7.2. Parameters
57.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.7.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| reportParamQuery.query | - | null | ||
| reportParamQuery.pagination.limit | - | null | ||
| reportParamQuery.pagination.offset | - | null | ||
| reportParamQuery.pagination.sortOption.field | - | null | ||
| reportParamQuery.pagination.sortOption.reversed | - | null | ||
| reportParamQuery.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| reportParamQuery.pagination.sortOption.aggregateBy.distinct | - | null |
57.1.7.3. Return Type
57.1.7.4. Content Type
- application/json
57.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.7.6. Samples
57.1.8. GetReportStatus
GET /v2/reports/jobs/{id}/status
GetReportStatus returns report status for the given report id
57.1.8.1. Description
57.1.8.2. Parameters
57.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.8.3. Return Type
57.1.8.4. Content Type
- application/json
57.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.8.6. Samples
57.1.9. ListReportConfigurations
GET /v2/reports/configurations
ListReportConfigurations returns report configurations matching given query
57.1.9.1. Description
57.1.9.2. Parameters
57.1.9.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
57.1.9.3. Return Type
57.1.9.4. Content Type
- application/json
57.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.9.6. Samples
57.1.10. PostReportConfiguration
POST /v2/reports/configurations
PostReportConfiguration creates a report configuration
57.1.10.1. Description
57.1.10.2. Parameters
57.1.10.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
57.1.10.3. Return Type
57.1.10.4. Content Type
- application/json
57.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.10.6. Samples
57.1.11. RunReport
POST /v2/reports/run
Submits a new report generation request if the user requesting this report does not have another waiting or preparing report for the same report configuration.
57.1.11.1. Description
57.1.11.2. Parameters
57.1.11.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
57.1.11.3. Return Type
57.1.11.4. Content Type
- application/json
57.1.11.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
57.1.11.6. Samples
57.1.12. UpdateReportConfiguration
PUT /v2/reports/configurations/{id}
UpdateReportConfiguration updates a report configuration
57.1.12.1. Description
57.1.12.2. Parameters
57.1.12.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
57.1.12.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
57.1.12.3. Return Type
Object
57.1.12.4. Content Type
- application/json
57.1.12.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
57.1.12.6. Samples
Chapter 58. Role Service
58.1. Role Service
58.1.1. ComputeEffectiveAccessScope
POST /v1/computeeffectiveaccessscope
ComputeEffectiveAccessScope
58.1.1.1. Description
Returns effective access scope based on the rules in the request. Does not persist anything; not idempotent due to possible changes to clusters and namespaces. POST is chosen due to potentially large payload. There are advantages in both keeping the response slim and detailed. If only IDs of selected clusters and namespaces are included, response latency and processing time are lower but the caller shall overlay the response with its view of the world which is susceptible to consistency issues. Listing all clusters and namespaces with related metadata is convenient for the caller but bloat the message with secondary data. We let the caller decide what level of detail they would like to have: - Minimal, when only roots of included subtrees are listed by their IDs. Clusters can be either INCLUDED (its namespaces are included but are not listed) or PARTIAL (at least one namespace is explicitly included). Namespaces can only be INCLUDED. - Standard [default], when all known clusters and namespaces are listed with their IDs and names. Clusters can be INCLUDED (all its namespaces are explicitly listed as INCLUDED), PARTIAL (all its namespaces are explicitly listed, some as INCLUDED and some as EXCLUDED), and EXCLUDED (all its namespaces are explicitly listed as EXCLUDED). Namespaces can be either INCLUDED or EXCLUDED. - High, when every cluster and namespace is augmented with metadata.
58.1.1.2. Parameters
58.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| accessScope | X |
58.1.1.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| detail | - | STANDARD |
58.1.1.3. Return Type
58.1.1.4. Content Type
- application/json
58.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.1.6. Samples
58.1.2. CreateRole
POST /v1/roles/{name}
58.1.2.1. Description
58.1.2.2. Parameters
58.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name | X | null |
58.1.2.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| role | X |
58.1.2.3. Return Type
Object
58.1.2.4. Content Type
- application/json
58.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.2.6. Samples
58.1.3. DeletePermissionSet
DELETE /v1/permissionsets/{id}
58.1.3.1. Description
58.1.3.2. Parameters
58.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.3.3. Return Type
Object
58.1.3.4. Content Type
- application/json
58.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.3.6. Samples
58.1.4. DeleteRole
DELETE /v1/roles/{id}
58.1.4.1. Description
58.1.4.2. Parameters
58.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.4.3. Return Type
Object
58.1.4.4. Content Type
- application/json
58.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.4.6. Samples
58.1.5. DeleteSimpleAccessScope
DELETE /v1/simpleaccessscopes/{id}
58.1.5.1. Description
58.1.5.2. Parameters
58.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.5.3. Return Type
Object
58.1.5.4. Content Type
- application/json
58.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.5.6. Samples
58.1.6. GetClustersForPermissions
GET /v1/sac/clusters
GetClustersForPermissions
58.1.6.1. Description
Returns the list of cluster ID and cluster name pairs that have at least read allowed by the scope of the requesting user for the list of requested permissions. Effective access scopes are only considered for input permissions that have cluster scope or narrower (i.e. global permissions from the input are ignored). If the input only contains permissions at global level, the output will be an empty list. If no permission is given in input, all clusters allowed by the requester scope for any permission with cluster scope or narrower will be part of the response.
58.1.6.2. Parameters
58.1.6.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| permissions |
| - | null |
58.1.6.3. Return Type
58.1.6.4. Content Type
- application/json
58.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.6.6. Samples
58.1.7. GetMyPermissions
GET /v1/mypermissions
58.1.7.1. Description
58.1.7.2. Parameters
58.1.7.3. Return Type
58.1.7.4. Content Type
- application/json
58.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.7.6. Samples
58.1.8. GetNamespacesForClusterAndPermissions
GET /v1/sac/clusters/{clusterId}/namespaces
GetNamespacesForClusterAndPermissions
58.1.8.1. Description
Returns the list of namespace ID and namespace name pairs that belong to the requested cluster and for which the user has at least read access granted for the list of requested permissions that have namespace scope or narrower (i.e. global and cluster permissions from the input are ignored). If the input only contains permissions at global or cluster level, the output will be an empty list. If no permission is given in input, all namespaces allowed by the requester scope for any permission with namespace scope or narrower will be part of the response.
58.1.8.2. Parameters
58.1.8.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| clusterId | X | null |
58.1.8.2.2. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| permissions |
| - | null |
58.1.8.3. Return Type
58.1.8.4. Content Type
- application/json
58.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.8.6. Samples
58.1.9. GetPermissionSet
GET /v1/permissionsets/{id}
58.1.9.1. Description
58.1.9.2. Parameters
58.1.9.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.9.3. Return Type
58.1.9.4. Content Type
- application/json
58.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.9.6. Samples
58.1.10. GetResources
GET /v1/resources
58.1.10.1. Description
58.1.10.2. Parameters
58.1.10.3. Return Type
58.1.10.4. Content Type
- application/json
58.1.10.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.10.6. Samples
58.1.11. GetRole
GET /v1/roles/{id}
58.1.11.1. Description
58.1.11.2. Parameters
58.1.11.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.11.3. Return Type
58.1.11.4. Content Type
- application/json
58.1.11.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.11.6. Samples
58.1.12. GetRoles
GET /v1/roles
58.1.12.1. Description
58.1.12.2. Parameters
58.1.12.3. Return Type
58.1.12.4. Content Type
- application/json
58.1.12.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.12.6. Samples
58.1.13. GetSimpleAccessScope
GET /v1/simpleaccessscopes/{id}
58.1.13.1. Description
58.1.13.2. Parameters
58.1.13.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
58.1.13.3. Return Type
58.1.13.4. Content Type
- application/json
58.1.13.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.13.6. Samples
58.1.14. ListPermissionSets
GET /v1/permissionsets
58.1.14.1. Description
58.1.14.2. Parameters
58.1.14.3. Return Type
58.1.14.4. Content Type
- application/json
58.1.14.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.14.6. Samples
58.1.15. ListSimpleAccessScopes
GET /v1/simpleaccessscopes
58.1.15.1. Description
58.1.15.2. Parameters
58.1.15.3. Return Type
58.1.15.4. Content Type
- application/json
58.1.15.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.15.6. Samples
58.1.16. PostPermissionSet
POST /v1/permissionsets
PostPermissionSet
58.1.16.1. Description
PermissionSet.id is disallowed in request and set in response.
58.1.16.2. Parameters
58.1.16.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | This encodes a set of permissions for StackRox resources. StoragePermissionSet | X |
58.1.16.3. Return Type
58.1.16.4. Content Type
- application/json
58.1.16.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.16.6. Samples
58.1.17. PostSimpleAccessScope
POST /v1/simpleaccessscopes
PostSimpleAccessScope
58.1.17.1. Description
SimpleAccessScope.id is disallowed in request and set in response.
58.1.17.2. Parameters
58.1.17.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | Simple access scope is a (simple) selection criteria for scoped resources. It does not allow multi-component AND-rules nor set operations on names. StorageSimpleAccessScope | X |
58.1.17.3. Return Type
58.1.17.4. Content Type
- application/json
58.1.17.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
58.1.17.6. Samples
58.1.18. PutPermissionSet
PUT /v1/permissionsets/{id}
58.1.18.1. Description
58.1.18.2. Parameters
58.1.18.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | id is generated and cannot be changed. | X | null |
58.1.18.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
58.1.18.3. Return Type
Object
58.1.18.4. Content Type
- application/json
58.1.18.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.18.6. Samples
58.1.19. PutSimpleAccessScope
PUT /v1/simpleaccessscopes/{id}
58.1.19.1. Description
58.1.19.2. Parameters
58.1.19.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id |
| X | null |
58.1.19.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
58.1.19.3. Return Type
Object
58.1.19.4. Content Type
- application/json
58.1.19.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.19.6. Samples
58.1.20. UpdateRole
PUT /v1/roles/{name}
58.1.20.1. Description
58.1.20.2. Parameters
58.1.20.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| name |
| X | null |
58.1.20.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
58.1.20.3. Return Type
Object
58.1.20.4. Content Type
- application/json
58.1.20.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
58.1.20.6. Samples
Chapter 59. Search Service
59.1. Search Service
59.1.1. Autocomplete
GET /v1/search/autocomplete
59.1.1.1. Description
59.1.1.2. Parameters
59.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| categories |
| - | null |
59.1.1.3. Return Type
59.1.1.4. Content Type
- application/json
59.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
59.1.1.6. Samples
59.1.2. Options
GET /v1/search/metadata/options
59.1.2.1. Description
59.1.2.2. Parameters
59.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| categories |
| - | null |
59.1.2.3. Return Type
59.1.2.4. Content Type
- application/json
59.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
59.1.2.6. Samples
59.1.3. Search
GET /v1/search
59.1.3.1. Description
59.1.3.2. Parameters
59.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| categories |
| - | null |
59.1.3.3. Return Type
59.1.3.4. Content Type
- application/json
59.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
59.1.3.6. Samples
Chapter 60. Secret Service
60.1. Secret Service
60.1.1. CountSecrets
GET /v1/secretscount
CountSecrets returns the number of secrets.
60.1.1.1. Description
60.1.1.2. Parameters
60.1.1.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
60.1.1.3. Return Type
60.1.1.4. Content Type
- application/json
60.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
60.1.1.6. Samples
60.1.2. GetSecret
GET /v1/secrets/{id}
GetSecret returns a secret given its ID.
60.1.2.1. Description
60.1.2.2. Parameters
60.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
60.1.2.3. Return Type
60.1.2.4. Content Type
- application/json
60.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
60.1.2.6. Samples
60.1.3. ListSecrets
GET /v1/secrets
ListSecrets returns the list of secrets.
60.1.3.1. Description
60.1.3.2. Parameters
60.1.3.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
60.1.3.3. Return Type
60.1.3.4. Content Type
- application/json
60.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
60.1.3.6. Samples
Chapter 61. Sensor Upgrade Service
61.1. Sensor Upgrade Service
61.1.1. GetSensorUpgradeConfig
GET /v1/sensorupgrades/config
61.1.1.1. Description
61.1.1.2. Parameters
61.1.1.3. Return Type
61.1.1.4. Content Type
- application/json
61.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
61.1.1.6. Samples
61.1.2. TriggerSensorCertRotation
POST /v1/sensorupgrades/rotateclustercerts/{id}
61.1.2.1. Description
61.1.2.2. Parameters
61.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
61.1.2.3. Return Type
Object
61.1.2.4. Content Type
- application/json
61.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
61.1.2.6. Samples
61.1.3. TriggerSensorUpgrade
POST /v1/sensorupgrades/cluster/{id}
61.1.3.1. Description
61.1.3.2. Parameters
61.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
61.1.3.3. Return Type
Object
61.1.3.4. Content Type
- application/json
61.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
61.1.3.6. Samples
61.1.4. UpdateSensorUpgradeConfig
POST /v1/sensorupgrades/config
61.1.4.1. Description
61.1.4.2. Parameters
61.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
61.1.4.3. Return Type
Object
61.1.4.4. Content Type
- application/json
61.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
61.1.4.6. Samples
Chapter 62. Service Account Service
62.1. Service Account Service
62.1.1. GetServiceAccount
GET /v1/serviceaccounts/{id}
62.1.1.1. Description
62.1.1.2. Parameters
62.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
62.1.1.3. Return Type
62.1.1.4. Content Type
- application/json
62.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
62.1.1.6. Samples
62.1.2. ListServiceAccounts
GET /v1/serviceaccounts
62.1.2.1. Description
62.1.2.2. Parameters
62.1.2.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
62.1.2.3. Return Type
62.1.2.4. Content Type
- application/json
62.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
62.1.2.6. Samples
Chapter 63. Service Identity Service
63.1. Service Identity Service
63.1.1. CreateServiceIdentity
POST /v1/serviceIdentities
CreateServiceIdentity creates a new key pair and certificate. The key and certificate are not retained and can never be retrieved again.
63.1.1.1. Description
63.1.1.2. Parameters
63.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
63.1.1.3. Return Type
63.1.1.4. Content Type
- application/json
63.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
63.1.1.6. Samples
63.1.2. GetAuthorities
GET /v1/authorities
GetAuthorities returns the authorities currently in use.
63.1.2.1. Description
63.1.2.2. Parameters
63.1.2.3. Return Type
63.1.2.4. Content Type
- application/json
63.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
63.1.2.6. Samples
63.1.3. GetServiceIdentities
GET /v1/serviceIdentities
63.1.3.1. Description
63.1.3.2. Parameters
63.1.3.3. Return Type
63.1.3.4. Content Type
- application/json
63.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
63.1.3.6. Samples
Chapter 64. Signature Integration Service
64.1. Signature Integration Service
64.1.1. DeleteSignatureIntegration
DELETE /v1/signatureintegrations/{id}
64.1.1.1. Description
64.1.1.2. Parameters
64.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
64.1.1.3. Return Type
Object
64.1.1.4. Content Type
- application/json
64.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
64.1.1.6. Samples
64.1.2. GetSignatureIntegration
GET /v1/signatureintegrations/{id}
64.1.2.1. Description
64.1.2.2. Parameters
64.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
64.1.2.3. Return Type
64.1.2.4. Content Type
- application/json
64.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
64.1.2.6. Samples
64.1.3. ListSignatureIntegrations
GET /v1/signatureintegrations
64.1.3.1. Description
64.1.3.2. Parameters
64.1.3.3. Return Type
64.1.3.4. Content Type
- application/json
64.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
64.1.3.6. Samples
64.1.4. PostSignatureIntegration
POST /v1/signatureintegrations
Integration id should not be set. Returns signature integration with id filled.
64.1.4.1. Description
64.1.4.2. Parameters
64.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
64.1.4.3. Return Type
64.1.4.4. Content Type
- application/json
64.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
64.1.4.6. Samples
64.1.5. PutSignatureIntegration
PUT /v1/signatureintegrations/{id}
64.1.5.1. Description
64.1.5.2. Parameters
64.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
64.1.5.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
64.1.5.3. Return Type
Object
64.1.5.4. Content Type
- application/json
64.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
64.1.5.6. Samples
Chapter 65. Summary Service
65.1. Summary Service
65.1.1. GetSummaryCounts
GET /v1/summary/counts
Deprecated starting 4.5.0 release, scheduled for removal starting 4.7.0.
65.1.1.1. Description
65.1.1.2. Parameters
65.1.1.3. Return Type
65.1.1.4. Content Type
- application/json
65.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
65.1.1.6. Samples
Chapter 66. Telemetry Service
66.1. Telemetry Service
66.1.1. ConfigureTelemetry
PUT /v1/telemetry/configure
66.1.1.1. Description
66.1.1.2. Parameters
66.1.1.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
66.1.1.3. Return Type
66.1.1.4. Content Type
- application/json
66.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
66.1.1.6. Samples
66.1.2. GetConfig
GET /v1/telemetry/config
66.1.2.1. Description
66.1.2.2. Parameters
66.1.2.3. Return Type
66.1.2.4. Content Type
- application/json
66.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
66.1.2.6. Samples
66.1.3. GetTelemetryConfiguration
GET /v1/telemetry/configure
66.1.3.1. Description
66.1.3.2. Parameters
66.1.3.3. Return Type
66.1.3.4. Content Type
- application/json
66.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
66.1.3.6. Samples
Chapter 67. User Service
67.1. User Service
67.1.1. GetUser
GET /v1/users/{id}
67.1.1.1. Description
67.1.1.2. Parameters
67.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
67.1.1.3. Return Type
67.1.1.4. Content Type
- application/json
67.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
67.1.1.6. Samples
67.1.2. GetUsers
GET /v1/users
67.1.2.1. Description
67.1.2.2. Parameters
67.1.2.3. Return Type
67.1.2.4. Content Type
- application/json
67.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
67.1.2.6. Samples
67.1.3. GetUsersAttributes
GET /v1/usersattributes
67.1.3.1. Description
67.1.3.2. Parameters
67.1.3.3. Return Type
67.1.3.4. Content Type
- application/json
67.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
67.1.3.6. Samples
Chapter 68. Vulnerability Exception Service
68.1. Vulnerability Exception Service
68.1.1. ApproveVulnerabilityException
POST /v2/vulnerability-exceptions/{id}/approve
ApproveVulnerabilityException approves a vulnerability exception. Once approved, the exception is enforced. The associated vulnerabilities are excluded from policy evaluation and risk evaluation, and the vulnerabilities may not appear in certain APIs responses by default.
68.1.1.1. Description
68.1.1.2. Parameters
68.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | REQUIRED. The ID of vulnerability exception to be approved. | X | null |
68.1.1.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | VulnerabilityExceptionServiceApproveVulnerabilityExceptionBody | X |
68.1.1.3. Return Type
68.1.1.4. Content Type
- application/json
68.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.1.6. Samples
68.1.2. CancelVulnerabilityException
POST /v2/vulnerability-exceptions/{id}/cancel
CancelVulnerabilityException cancels a vulnerability exception. Once cancelled, an approved exception is no longer enforced. Cancelled exceptions are garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET /v1/config/).
68.1.2.1. Description
68.1.2.2. Parameters
68.1.2.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
68.1.2.3. Return Type
68.1.2.4. Content Type
- application/json
68.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.2.6. Samples
68.1.3. CreateDeferVulnerabilityException
POST /v2/vulnerability-exceptions/deferral
CreateDeferVulnerabilityException creates an exception request to defer specified vulnerabilities. Once an exception is created, it remains in the PENDING state until the approval. The exception is enforced only after it is approved. Once the exception expires, it is garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET`/v1/config/`)
68.1.3.1. Description
68.1.3.2. Parameters
68.1.3.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
68.1.3.3. Return Type
68.1.3.4. Content Type
- application/json
68.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.3.6. Samples
68.1.4. CreateFalsePositiveVulnerabilityException
POST /v2/vulnerability-exceptions/false-positive
CreateFalsePositiveVulnerabilityException creates an exception request to mark specified vulnerabilities as false positive. Once an exception is created, it remains in the PENDING state until the approval. The exception is enforced only after it is approved.
68.1.4.1. Description
68.1.4.2. Parameters
68.1.4.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
68.1.4.3. Return Type
68.1.4.4. Content Type
- application/json
68.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.4.6. Samples
68.1.5. DeleteVulnerabilityException
DELETE /v2/vulnerability-exceptions/{id}
DeleteVulnerabilityException deletes a vulnerability exception. Only pending exceptions and pending updates to an enforced exception can be deleted. To revert an exception use cancel API. All exceptions are retained in the system according to the retention configuration.
68.1.5.1. Description
68.1.5.2. Parameters
68.1.5.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
68.1.5.3. Return Type
Object
68.1.5.4. Content Type
- application/json
68.1.5.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
68.1.5.6. Samples
68.1.6. DenyVulnerabilityException
POST /v2/vulnerability-exceptions/{id}/deny
DenyVulnerabilityException denies a vulnerability exception. Denied exceptions are inactive and are garbage collected as per the retention configuration .expiredVulnReqRetentionDurationDays (GET`/v1/config/`)
68.1.6.1. Description
68.1.6.2. Parameters
68.1.6.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | REQUIRED. The ID of vulnerability exception to be denied. | X | null |
68.1.6.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
68.1.6.3. Return Type
68.1.6.4. Content Type
- application/json
68.1.6.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.6.6. Samples
68.1.7. GetVulnerabilityException
GET /v2/vulnerability-exceptions/{id}
GetVulnerabilityException returns the vulnerability exception with specified ID.
68.1.7.1. Description
68.1.7.2. Parameters
68.1.7.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
68.1.7.3. Return Type
68.1.7.4. Content Type
- application/json
68.1.7.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.7.6. Samples
68.1.8. ListVulnerabilityExceptions
GET /v2/vulnerability-exceptions
ListVulnerabilityExceptions returns a list of vulnerability exceptions.
68.1.8.1. Description
68.1.8.2. Parameters
68.1.8.2.1. Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
68.1.8.3. Return Type
68.1.8.4. Content Type
- application/json
68.1.8.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.8.6. Samples
68.1.9. UpdateVulnerabilityException
PATCH /v2/vulnerability-exceptions/{id}
UpdateVulnerabilityException updates an existing vulnerability exception. The update is enforced only once it is approved. Currently only the following can be updated: - CVEs and expiry of the deferral exceptions - CVEs of the false positive exception
68.1.9.1. Description
68.1.9.2. Parameters
68.1.9.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | REQUIRED. The ID of vulnerability exception to be updated. | X | null |
68.1.9.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | VulnerabilityExceptionServiceUpdateVulnerabilityExceptionBody | X |
68.1.9.3. Return Type
68.1.9.4. Content Type
- application/json
68.1.9.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
68.1.9.6. Samples
Chapter 69. Vulnerability Request Service
69.1. Vulnerability Request Service
69.1.1. ApproveVulnerabilityRequest
POST /v1/cve/requests/{id}/approve
ApproveVulnRequest approve a vulnerability request. If it is an unwatch vulnerability request then the associated vulnerabilities are not watched in workflows such as policy detection, risk, etc.
69.1.1.1. Description
69.1.1.2. Parameters
69.1.1.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
69.1.1.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
69.1.1.3. Return Type
69.1.1.4. Content Type
- application/json
69.1.1.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
69.1.1.6. Samples
69.1.2. DeferVulnerability
POST /v1/cve/requests/defer
DeferVulnerability starts the deferral process for the specified vulnerability.
69.1.2.1. Description
69.1.2.2. Parameters
69.1.2.2.1. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
69.1.2.3. Return Type
69.1.2.4. Content Type
- application/json
69.1.2.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
69.1.2.6. Samples
69.1.3. DeleteVulnerabilityRequest
DELETE /v1/cve/requests/{id}
DeleteVulnerabilityRequest deletes a vulnerability request.
69.1.3.1. Description
69.1.3.2. Parameters
69.1.3.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
69.1.3.3. Return Type
Object
69.1.3.4. Content Type
- application/json
69.1.3.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
69.1.3.6. Samples
69.1.4. DenyVulnerabilityRequest
POST /v1/cve/requests/{id}/deny
DenyVulnRequest denies a vulnerability request.
69.1.4.1. Description
69.1.4.2. Parameters
69.1.4.2.1. Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
69.1.4.2.2. Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
69.1.4.3. Return Type
69.1.4.4. Content Type
- application/json
69.1.4.5. Responses
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |