Attributes for creating or updating a rule. Server-managed fields (created_at, modified_at, custom) are excluded.
description
string
Explanation of the rule.
enabled
boolean
If enabled, the rule is calculated as part of the score.
level
int32
The maturity level of the rule (1, 2, or 3).
name
string
Name of the rule.
owner
string
Owner of the rule.
scope_query
string
A query to filter which entities this rule applies to.
scorecard_name
string
The scorecard name to which this rule must belong.
type
enum
The JSON:API type for scorecard rules.
Allowed enum values: rule
default: rule
{"data":{"type":"rule","attributes":{"enabled":true,"name":"Team Defined","scorecard_name":"Deployments automated via Deployment Trains","description":"Updated description via test"}}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key [required]
string
The unique key for the campaign.
modified_at [required]
date-time
Time of last campaign modification.
name [required]
string
The name of the campaign.
owner [required]
string
The UUID of the campaign owner.
start_date [required]
date-time
The start date of the campaign.
status [required]
string
The status of the campaign.
id [required]
string
The unique ID of the campaign.
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
meta [required]
object
Metadata for scores response.
count [required]
int64
Number of entities in this response.
limit [required]
int64
Pagination limit.
offset [required]
int64
Pagination offset.
total [required]
int64
Total number of entities available.
{"data":[{"attributes":{"created_at":"2023-12-15T10:30:00Z","description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","modified_at":"2024-01-05T14:20:00Z","name":"Q1 Security Campaign","owner":"550e8400-e29b-41d4-a716-446655440000","start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"id":"c10ODp0VCrrIpXmz","type":"campaign"}],"meta":{"count":10,"limit":10,"offset":0,"total":150}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key [required]
string
The unique key for the campaign.
name [required]
string
The name of the campaign.
owner_id [required]
string
The UUID of the campaign owner.
rule_ids [required]
[string]
Array of rule IDs associated with this campaign.
start_date [required]
date-time
The start date of the campaign.
status
enum
The status of the campaign.
Allowed enum values: in_progress,not_started,completed
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
{"data":{"attributes":{"description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","name":"Q1 Security Campaign","owner_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["q8MQxk8TCqrHnWkx","r9NRyl9UDrsIoXly"],"start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"type":"campaign"}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key [required]
string
The unique key for the campaign.
modified_at [required]
date-time
Time of last campaign modification.
name [required]
string
The name of the campaign.
owner [required]
string
The UUID of the campaign owner.
start_date [required]
date-time
The start date of the campaign.
status [required]
string
The status of the campaign.
id [required]
string
The unique ID of the campaign.
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
{"data":{"attributes":{"created_at":"2023-12-15T10:30:00Z","description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","modified_at":"2024-01-05T14:20:00Z","name":"Q1 Security Campaign","owner":"550e8400-e29b-41d4-a716-446655440000","start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"id":"c10ODp0VCrrIpXmz","type":"campaign"}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key [required]
string
The unique key for the campaign.
modified_at [required]
date-time
Time of last campaign modification.
name [required]
string
The name of the campaign.
owner [required]
string
The UUID of the campaign owner.
start_date [required]
date-time
The start date of the campaign.
status [required]
string
The status of the campaign.
id [required]
string
The unique ID of the campaign.
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
{"data":{"attributes":{"created_at":"2023-12-15T10:30:00Z","description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","modified_at":"2024-01-05T14:20:00Z","name":"Q1 Security Campaign","owner":"550e8400-e29b-41d4-a716-446655440000","start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"id":"c10ODp0VCrrIpXmz","type":"campaign"}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key
string
The unique key for the campaign.
name [required]
string
The name of the campaign.
owner_id [required]
string
The UUID of the campaign owner.
rule_ids [required]
[string]
Array of rule IDs associated with this campaign.
start_date [required]
date-time
The start date of the campaign.
status [required]
string
The status of the campaign.
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
{"data":{"attributes":{"description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","name":"Q1 Security Campaign","owner_id":"550e8400-e29b-41d4-a716-446655440000","rule_ids":["q8MQxk8TCqrHnWkx","r9NRyl9UDrsIoXly"],"start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"type":"campaign"}}
Entity scope query to filter entities for this campaign.
guidance
string
Guidance for the campaign.
key [required]
string
The unique key for the campaign.
modified_at [required]
date-time
Time of last campaign modification.
name [required]
string
The name of the campaign.
owner [required]
string
The UUID of the campaign owner.
start_date [required]
date-time
The start date of the campaign.
status [required]
string
The status of the campaign.
id [required]
string
The unique ID of the campaign.
type [required]
enum
The JSON:API type for campaigns.
Allowed enum values: campaign
{"data":{"attributes":{"created_at":"2023-12-15T10:30:00Z","description":"Campaign to improve security posture for Q1 2024.","due_date":"2024-03-31T23:59:59Z","entity_scope":"kind:service AND team:platform","guidance":"Please ensure all services pass the security requirements.","key":"q1-security-2024","modified_at":"2024-01-05T14:20:00Z","name":"Q1 Security Campaign","owner":"550e8400-e29b-41d4-a716-446655440000","start_date":"2024-01-01T00:00:00Z","status":"in_progress"},"id":"c10ODp0VCrrIpXmz","type":"campaign"}}
The JSON:API type for scorecard list.
Allowed enum values: scorecard
{"data":[{"attributes":{"created_at":"2023-01-15T10:30:00Z","description":"Best practices for observability.","modified_at":"2024-01-05T14:20:00Z","name":"Observability Best Practices"},"id":"q8MQxk8TCqrHnWkx","type":"scorecard"}]}
