Request Scorecard rule exemption
POST/api/v1/scorecards/:tag/entity/:entityTag/exemption
Request Scorecard rule exemption
Request
Path Parameters
Unique tag for the Scorecard
The entity tag (x-cortex-tag
) that identifies the entity.
- application/json
Body
required
Number of days how long rule should be exempt. If not set, rule will be exempt until exempt until revoked.
Reason for creating exemption
Identifier of the Scorecard rule to request exemption for
Responses
- 200
- 404
Successfully requested Scorecard rule exemption
- application/json
- Schema
- Example (from schema)
Schema
- RuleExemptionUserActor
- RuleExemptionApiActor
- RuleExemptionUserActor
- RuleExemptionApiActor
exemptionStatus
object
required
Date on which the exemption was approved or rejected. Null if the status is pending
handledBy
object
API key or person who requested, approved, or rejected the exemption
oneOf
Email of the person who requested, approved or rejected the exemption
Name of the person who requested, approved or rejected the exemption
Last 4 digits of the API key used to approve or reject the exemption
Status of the exemption. Possible values are APPROVED, REJECTED, and PENDING
requestedBy
object
required
API key or person who requested, approved, or rejected the exemption
oneOf
Email of the person who requested, approved or rejected the exemption
Name of the person who requested, approved or rejected the exemption
Last 4 digits of the API key used to approve or reject the exemption
{
"endDate": "2024-05-17T18:35:11.461Z",
"exemptionStatus": {
"date": "2024-05-17T18:35:11.461Z",
"handledBy": {},
"status": "string"
},
"requestedBy": {},
"requestedDate": "2024-05-17T18:35:11.461Z",
"requestingReason": "string"
}
Scorecard not found, entity not found, or rule with given identifier not found within the Scorecard
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [INTEGRATION_MISSING
, INTEGRATION_UNREGISTERED
, INTEGRATION_UNSUPPORTED
, INTEGRATION_GRAPHQL_ERROR
, INTEGRATION_BAD_REQUEST
, INTEGRATION_UNAUTHORIZED
, INTEGRATION_FORBIDDEN
, INTEGRATION_NOT_FOUND
, INTEGRATION_UNPROCESSABLE_CONTENT
, INTEGRATION_RATE_LIMITED
, INTEGRATION_INTERNAL_ERROR
, INTEGRATION_NOT_IMPLEMENTED
, INTEGRATION_BAD_GATEWAY
, INTEGRATION_UNAVAILABLE
, INTEGRATION_GATEWAY_TIMEOUT
, INTEGRATION_TIMED_OUT
, INTEGRATION_CACHE_ERROR
, INTEGRATION_UNHANDLED_HTTP_ERROR
, INTEGRATION_UNHANDLED_EXCEPTION
, INTEGRATION_UNEXPECTED_ERROR
, ILLEGAL_ARGUMENT_ERROR
, BAD_REQUEST
, FORBIDDEN
, NOT_FOUND
, REQUEST_TIMEOUT
, CONFLICT
, UNHANDLED_EXCEPTION
, UNCATEGORIZED
, SERVICE_CREATOR
, UNKNOWN_HOST
]
{
"details": "string",
"gatewayHttpStatus": 0,
"httpStatus": 0,
"message": "string",
"requestId": "string",
"type": "INTEGRATION_MISSING"
}