Compliance Swagger API

GET /archivist/v1/compliance/assets/{uuid}

List all compliance status relevant to an asset

Parameters

• uuid (string) – Specify the Asset UUID where assets/{uuid} is the Asset Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity assets/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters

• page_size (integer) – Maximum results per page.

• page_token (string) – The next_page_token returned from a previous list request if any.

• order_by (string) – Specify the sort order for the results.

• compliant_at (string) –

  timestamp at which compliance is determined

  time at which compliance is determined

Status Codes

• 200 OK – A successful response.

• 206 Partial Content – The number of compliance statements exceeds the servers limit.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to access the requested resource.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• compliance[].compliance_policy_identity (string) – identity of the compliance policy (read only)

• compliance[].compliant (boolean) – status of compliance against the compliance policy

• compliance[].reason (string) – reason for non-compliance (read only)

• compliant (boolean) – overall compliance status for the asset

• compliant_at (string) – time at which compliance is determined (read only)

• next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

GET /archivist/v1/compliance_policies

Query Parameters

• page_size (integer) – Maximum results per page.

• page_token (string) – The next_page_token returned from a previous list request if any.

• order_by (string) – Specify the sort order for the results.

• compliance_type (string) – policy type

• description (string) – Customer description of the compliance policy.

• display_name (string) – Customer friendly name for the compliance policy.

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to access the requested resource.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• compliance_policies[].asset_filter[].or[] (string) –

• compliance_policies[].closing_event_display_type (string) –

• compliance_policies[].compliance_type (string) –

• compliance_policies[].description (string) –

• compliance_policies[].display_name (string) –

• compliance_policies[].dynamic_variability (number) –

• compliance_policies[].dynamic_window (string) –

• compliance_policies[].event_display_type (string) –

• compliance_policies[].identity (string) –

• compliance_policies[].richness_assertions[].or[] (string) –

• compliance_policies[].time_period_seconds (string) –

• next_page_token (string) –

POST /archivist/v1/compliance_policies

Request JSON Object

• asset_filter[].or[] (string) –

• closing_event_display_type (string) – this is the correlated event type (read only)

• compliance_type (string) –

• description (string) – Customer description of the compliance policy. (read only)

• display_name (string) – display name (read only)

• dynamic_variability (number) – number of standard deviations - required for DYNAMIC_TOLERANCE (read only)

• dynamic_window (string) – valid period for policy - required for DYNAMIC_TOLERANCE (read only)

• event_display_type (string) – this is the target event_display_type - always required (read only)

• richness_assertions[].or[] (string) –

• time_period_seconds (string) – time delta - required for SINCE and PERIOD_OUTSTANDING (read only)

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 402 Payment Required – Returned when the user’s quota of compliance policies has been reached.

• 403 Forbidden – Returned when the user is not authorized to access the requested resource.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• asset_filter[].or[] (string) –

• closing_event_display_type (string) –

• compliance_type (string) –

• description (string) –

• display_name (string) –

• dynamic_variability (number) –

• dynamic_window (string) –

• event_display_type (string) –

• identity (string) –

• richness_assertions[].or[] (string) –

• time_period_seconds (string) –

GET /archivist/v1/compliance_policies/{uuid}

Parameters

• uuid (string) – Specify the Compliance Policy UUID where compliance_policies/{uuid} is the Compliance Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity compliance_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to access the requested resource.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• asset_filter[].or[] (string) –

• closing_event_display_type (string) –

• compliance_type (string) –

• description (string) –

• display_name (string) –

• dynamic_variability (number) –

• dynamic_window (string) –

• event_display_type (string) –

• identity (string) –

• richness_assertions[].or[] (string) –

• time_period_seconds (string) –

DELETE /archivist/v1/compliance_policies/{uuid}

Parameters

• uuid (string) – Specify the Compliance Policy UUID where compliance_policies/{uuid} is the Compliance Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity compliance_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to access the requested resource.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• asset_filter[].or[] (string) –

• closing_event_display_type (string) –

• compliance_type (string) –

• description (string) –

• display_name (string) –

• dynamic_variability (number) –

• dynamic_window (string) –

• event_display_type (string) –

• identity (string) –

• richness_assertions[].or[] (string) –

• time_period_seconds (string) –

GET /archivist/v1/compliance_policies:caps

Get remaining capped resources for CompliancePolicies

Not stable or officially supported. Get remaining capped resources for CompliancePolicies

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• caps[].resource_remaining (string) – Number of capped resources remaining

• caps[].resource_type (string) – String identifying the capped resource type

GET /archivist/v1/compliance_policies:openapi

Get OpenAPI spec for Compliance

Get OpenAPI v2.0 spec for Compliance

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

GET /archivist/v1/compliance_policies:openapi-ui

Get OpenAPI UI for Compliance

Get OpenAPI v2.0 UI for Compliance

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.