v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBScorecards
Update a campaign
Updates an existing campaign.
put/api/v2/scorecard/campaigns/{campaign_id}
Path parameters
campaign_idstring required
Example:c10ODp0VCrrIpXmz
Campaign ID or key.
Request body
Example request
{
"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"
}
}Response
OK
Example response
{
"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"
}
}