API ReferenceAPI Governance

Create a ruleset

View as Markdown
Creates a new ruleset for the team.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-zA-Z0-9_.-]+$"<=255 characters
The ruleset's name. Must be unique within the team and only contain letters, numbers, hyphens, underscores, and periods.
descriptionstringRequired<=1000 characters
The ruleset's description.
engineenumRequired
The governance engine that runs the ruleset.
Allowed values:
formatenumRequired
The type of resource the ruleset governs.
Allowed values:
contentstringRequired

The ruleset’s content, up to a maximum of 500 KB (UTF-8).

Response

Ruleset Created
idstring
The resource's ID.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error