policysets

Create, edit and delete Governance policy sets

policysets#list

List all policy sets

Security or

Request

query Parameters

accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project
per_page	integer [ 1 .. 100 ] Default: 50 Number of results per page Example: per_page=20
page	integer >= 0 Default: 0 Page number (starting from 0) Example: page=4
searchTerm	string Default: "" Filter results by partial name match Example: searchTerm=poli
sort	string Default: "name,ASC" Sort order for results Enum: "name,ASC" "name,DESC" "updated,ASC" "updated,DESC" Example: sort=updated,DESC
type	string non-empty Filter results by type Example: type=pipeline
action	string non-empty Filter results by action Example: action=onrun

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Sequi quam ratione molestiae.

Responses

200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/policysets

Response samples

application/json

[{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"enabled": true,
"entitySelector": "all_entities_in_scope",
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"policies": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
}
],
"project_id": "test-project",
"resourceGroups": [{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
},
{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
},
{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
}
],
"type": "pipeline",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"enabled": true,
"entitySelector": "all_entities_in_scope",
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"policies": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
}
],
"project_id": "test-project",
"resourceGroups": [{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
},
{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
},
{"account_id": "Voluptatem consequatur voluptatum velit suscipit reiciendis.",
"created": 3767837804677254000,
"identifier": "Deserunt dignissimos quia quasi consectetur.",
"name": "Omnis nulla placeat fuga.",
"org_id": "Quisquam eveniet omnis et sunt.",
"project_id": "Ratione cum et cumque est corporis non."
}
],
"type": "pipeline",
"updated": 1636669297674
}
]

policysets#create

Create a policy set

Security or

Request

query Parameters

accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Eius veritatis dignissimos.

Request Body schema: application/json

action required	string non-empty Action that triggers the policy set
description	string Description of the policy set
enabled required	boolean Only enabled policy sets are evaluated when evaluating by type/action
identifier required	string non-empty Identifier for the policy set
name required	string non-empty Name of the policy set
type required	string non-empty Type of input suitable for the policy set

Responses

201

Created response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

post/pm/api/v1/policysets

Request samples

Payload

application/json

{"action": "onrun",
"description": "Captures critical production policies",
"enabled": true,
"identifier": "policyset-1",
"name": "Production Policies",
"type": "pipeline"
}

Response samples

application/json

{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"enabled": true,
"entitySelector": "all_entities_in_resource_groups",
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"policies": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
}
],
"project_id": "test-project",
"resourceGroups": [{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
}
],
"type": "pipeline",
"updated": 1636669297674
}

policysets#delete

Delete a policy set by identifier

Security or

Request

path Parameters

identifier

required

string non-empty

Identifier of the policy set

Examples:

default policyset-1

query Parameters

accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Accusantium odit aut et.

Responses

204

No Content response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

delete/pm/api/v1/policysets/{identifier}

policysets#find

Find a policy set by identifier

Security or

Request

path Parameters

identifier

required

string non-empty

Identifier of the policy set to retrieve

Examples:

default policyset-1

query Parameters

accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Aut esse nobis et quos.

Responses

200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/policysets/{identifier}

Response samples

application/json

{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"action": "onrun",
"created": 1636669297674,
"description": "Captures critical production policies",
"enabled": true,
"entitySelector": "all_entities_in_resource_groups",
"identifier": "policyset-1",
"name": "Production Policies",
"org_id": "test-org",
"policies": [{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
},
{"account_id": "eBqAoNchMLKigC_qZ5EdC",
"created": 1636669297674,
"identifier": "policy-1",
"name": "Pipeline Approval",
"org_id": "test-org",
"project_id": "test-project",
"rego": "",
"severity": "warning",
"updated": 1636669297674
}
],
"project_id": "test-project",
"resourceGroups": [{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
},
{"account_id": "Quis et doloribus eveniet optio.",
"created": 2537790190831681500,
"identifier": "Quia consectetur in dolorum est sit amet.",
"name": "Dolorum dolore sed ipsa repudiandae.",
"org_id": "Est quia.",
"project_id": "Non corporis cumque debitis quisquam et."
}
],
"type": "pipeline",
"updated": 1636669297674
}

policysets#update

Update a policy set by identifier

Security or

Request

path Parameters

identifier

required

string

Identifier of the policy set

Example: policyset-1

query Parameters

accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Dolor enim reprehenderit tempora suscipit aut consectetur.

Request Body schema: application/json

action	string non-empty Action that triggers the policy set
description	string Description of the policy set
enabled	boolean Only enabled policy sets are evaluated when evaluating by type/action
entitySelector	string A string enum value which determines which entities the policy set applies to during evaluation. This feature is not available for all accounts, Contact support if you wish to have it enabled. Enum: "all_entities_in_scope" "all_entities_in_resource_groups"
name	string Name of the policy set
	Array of objects (Linkedpolicyidentifier) Policies linked to this policy set
	Array of objects (ResourceGroupIdentifier) Resource groups that contain the resources that this policy set should be evaluated for. Resource groups are not supported for flag or custom policy sets. This feature is not available for all accounts, Contact support if you wish to have it enabled.
type	string Type of input suitable for the policy set

Responses

204

No Content response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

patch/pm/api/v1/policysets/{identifier}

Request samples

Payload

application/json

{"action": "onrun",
"description": "Captures critical production policies",
"enabled": true,
"entitySelector": "all_entities_in_scope",
"name": "Production Policies",
"policies": [{"identifier": "policy-1",
"severity": "warning"
},
{"identifier": "policy-1",
"severity": "warning"
},
{"identifier": "policy-1",
"severity": "warning"
}
],
"resourceGroups": [{"account_id": "Iure dolorum qui et ut ea labore.",
"identifier": "Maiores harum est quam minima culpa omnis.",
"org_id": "Ut aperiam illo rerum enim.",
"project_id": "Quidem consectetur sint quis atque aut."
},
{"account_id": "Iure dolorum qui et ut ea labore.",
"identifier": "Maiores harum est quam minima culpa omnis.",
"org_id": "Ut aperiam illo rerum enim.",
"project_id": "Quidem consectetur sint quis atque aut."
},
{"account_id": "Iure dolorum qui et ut ea labore.",
"identifier": "Maiores harum est quam minima culpa omnis.",
"org_id": "Ut aperiam illo rerum enim.",
"project_id": "Quidem consectetur sint quis atque aut."
}
],
"type": "pipeline"
}

➔ Next to system