Update Control

put

https://{hostname}/api/controls/v1/controls/{controlId}

Use this API to update the attributes of a specific control in the Controls Library.

Path Params

controlId

uuid

required

ID of the control. This value is obtained using Get List of Controls API.

Body Params

identifier

string

required

length between 1 and 50

The identifier of the control.

name

string

required

length between 1 and 300

The name of the control.

orgGroupId

uuid

required

The identifier of the organization the master control is linked to. In general, this is top organization in the org hierarchy.

description

string

length between 0 and 4000

Description of the control.

recommendation

string

length between 0 and 500

The recommendation status of this control based on Athena logic.

frameworkId

uuid

Identifier of the framework the control is tied to.

frameworkName

string

length between 0 and 500

Name of the framework the control is tied to.

frameworkNameKey

string

length between 0 and 500

Identifier used for translation of Framework Name.

status

string

enum

The new status of the control. This can be Active, Archived, or Pending.

Allowed:

categoryId

uuid

The identifier of the category tied to the control. Optional if no category is needed or if category name is provided.

categoryName

string

length between 0 and 500

The name of the category tied to the control. Optional if category Id is provided.

categoryNameKey

string

length between 0 and 500

Identifier used for translation of category name. Optional if category Id is provided.

attributes

object

Custom Attributes

implementationGuidance

string

Implementation guidance of control.

scopeId

uuid

The identifier of the scope associated with this control.

justificationIds

array of uuids

Set of justification identifiers explaining why this control is included in the framework.

justificationIds

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

200OK

429Too Many Requests. For more information, see API Rate Limits.