API docs by Redocly

CISO Assistant API — Frameworks & Libraries (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

frameworks

frameworks_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
baseline
string

Baseline

folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

provider
string
search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

frameworks_create

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
name
string <= 200 characters
description
string or null
annotation
string or null
is_published
boolean (Published)
editing_version
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]

Incremented on each publish.

urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
min_score
integer <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups_definition
any or null
outcomes_definition
any
field_visibility
any

Override visibility per field. Keys: field names. Values: 'everyone', 'auditor', or 'hidden'.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "folder": "string",
  • "library": "string",
  • "reference_controls": [
    ],
  • "is_dynamic": true,
  • "has_update": true,
  • "has_editing_draft": "string",
  • "scores_definition": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

frameworks_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "folder": "string",
  • "library": "string",
  • "reference_controls": [
    ],
  • "is_dynamic": true,
  • "has_update": true,
  • "has_editing_draft": "string",
  • "scores_definition": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

frameworks_update

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Request Body schema:
name
string <= 200 characters
description
string or null
annotation
string or null
is_published
boolean (Published)
editing_version
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]

Incremented on each publish.

urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
min_score
integer <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups_definition
any or null
outcomes_definition
any
field_visibility
any

Override visibility per field. Keys: field names. Values: 'everyone', 'auditor', or 'hidden'.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "folder": "string",
  • "library": "string",
  • "reference_controls": [
    ],
  • "is_dynamic": true,
  • "has_update": true,
  • "has_editing_draft": "string",
  • "scores_definition": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

frameworks_partial_update

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Request Body schema:
name
string <= 200 characters
description
string or null
annotation
string or null
is_published
boolean (Published)
editing_version
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]

Incremented on each publish.

urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
default_locale
boolean
min_score
integer <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups_definition
any or null
outcomes_definition
any
field_visibility
any

Override visibility per field. Keys: field names. Values: 'everyone', 'auditor', or 'hidden'.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "folder": "string",
  • "library": "string",
  • "reference_controls": [
    ],
  • "is_dynamic": true,
  • "has_update": true,
  • "has_editing_draft": "string",
  • "scores_definition": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "editing_version": -9223372036854776000,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "implementation_groups_definition": null,
  • "outcomes_definition": null,
  • "field_visibility": null
}

frameworks_destroy

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_discard_draft_create

Discard editing_draft without affecting relational data.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_duplicate_create

Deep-clone a framework with all requirement nodes, questions, and choices.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_excel_template_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_mapping_stats_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_mappings_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_object_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_publish_draft_create

Publish editing_draft → relational DB, snapshot history, bump version.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_save_draft_partial_update

Update editing_draft with the current WIP from the frontend.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_serve_image_retrieve

Serve an image attachment belonging to this framework.

Authorizations:
knoxApiToken
path Parameters
attachment_id
required
string^[0-9a-f-]+$
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_start_editing_create

Serialize the framework tree into editing_draft to begin editing.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_tree_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_upload_image_create

Upload an image to this framework (for splash screen markdown in draft mode).

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Framework.

Responses

frameworks_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

frameworks_names_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken

Responses

frameworks_provider_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken

Responses

frameworks_used_retrieve

API endpoint that allows frameworks to be viewed or edited.

Authorizations:
knoxApiToken

Responses

loaded-libraries

loaded_libraries_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
has_update
boolean
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

locale
Array of strings
Items Enum: "ar" "cs" "da" "de" "el" "en" "es" "fr" "hi" "hr" "hu" "id" "it" "ko" "lt" "nl" "pl" "pt" "ro" "sv" "tr" "uk" "ur" "zh"
  • en - en
  • fr - fr
  • es - es
  • de - de
  • it - it
  • nl - nl
  • pl - pl
  • pt - pt
  • ar - ar
  • ro - ro
  • hi - hi
  • ur - ur
  • cs - cs
  • sv - sv
  • id - id
  • da - da
  • hu - hu
  • uk - uk
  • el - el
  • tr - tr
  • hr - hr
  • zh - zh
  • lt - lt
  • ko - ko
object_type
Array of strings
Items Enum: "framework" "frameworks" "metric_definitions" "reference_controls" "requirement_mapping_set" "requirement_mapping_sets" "risk_matrices" "risk_matrix" "threats"
  • threats - threats
  • reference_controls - reference_controls
  • metric_definitions - metric_definitions
  • risk_matrix - risk_matrix
  • risk_matrices - risk_matrices
  • framework - framework
  • frameworks - frameworks
  • requirement_mapping_set - requirement_mapping_set
  • requirement_mapping_sets - requirement_mapping_sets
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

packager
string
provider
string
search
string

A search term.

urn
string
version
integer

Responses

Response samples

Content type
application/json
{}

loaded_libraries_create

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
dependencies
required
Array of strings
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "dependencies": [
    ],
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_update

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
dependencies
required
Array of strings
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "dependencies": [
    ],
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema:
name
string
description
string or null
annotation
string or null
dependencies
Array of strings
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "dependencies": [
    ],
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

loaded_libraries_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_content_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_tree_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_update_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_available_updates_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

loaded_libraries_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
dependencies
required
Array of strings
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "dependencies": [
    ],
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "dependencies": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

mapping-libraries

mapping_libraries_list

Authorizations:
knoxApiToken
query Parameters
limit
integer

Number of results to return per page.

locale
string
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

packager
string
provider
string
search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

preset-journey-steps

preset_journey_steps_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

journey
Array of strings <uuid> [ items <uuid > ]
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

status
Array of strings
Items Enum: "done" "in_progress" "not_started" "skipped"
  • not_started - Not Started
  • in_progress - In Progress
  • done - Done
  • skipped - Skipped

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

preset_journey_steps_create

Authorizations:
knoxApiToken
Request Body schema:
status
string (Status1d7Enum)
Enum: "not_started" "in_progress" "done" "skipped"
  • not_started - Not Started
  • in_progress - In Progress
  • done - Done
  • skipped - Skipped
notes
string
target_ref
string or null <= 100 characters

Responses

Request samples

Content type
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

Response samples

Content type
application/json
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

preset_journey_steps_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "key": "string",
  • "order": -9223372036854776000,
  • "target_model": "string",
  • "target_ref": "string",
  • "status": "not_started",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "journey": "9145b29e-e005-46f9-b016-19d8056c2825",
  • "completed_by": "c9235180-61dd-4e9a-a3ba-27dfed282f7f"
}

preset_journey_steps_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Request Body schema:
status
string (Status1d7Enum)
Enum: "not_started" "in_progress" "done" "skipped"
  • not_started - Not Started
  • in_progress - In Progress
  • done - Done
  • skipped - Skipped
notes
string
target_ref
string or null <= 100 characters

Responses

Request samples

Content type
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

Response samples

Content type
application/json
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

preset_journey_steps_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Request Body schema:
status
string (Status1d7Enum)
Enum: "not_started" "in_progress" "done" "skipped"
  • not_started - Not Started
  • in_progress - In Progress
  • done - Done
  • skipped - Skipped
notes
string
target_ref
string or null <= 100 characters

Responses

Request samples

Content type
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

Response samples

Content type
application/json
{
  • "status": "not_started",
  • "notes": "string",
  • "target_ref": "string"
}

preset_journey_steps_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Responses

preset_journey_steps_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Responses

preset_journey_steps_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey step.

Responses

preset_journey_steps_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

preset-journeys

preset_journeys_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

preset_journeys_create

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string <= 200 characters
description
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

preset_journeys_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "steps": [
    ],
  • "folder": "string",
  • "latest_version": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "urn": "string",
  • "version": -9223372036854776000,
  • "object_refs": null,
  • "applied_at": "2019-08-24T14:15:22Z",
  • "applied_by": "e0067bec-7ec0-4033-8469-e4bdcb9ebd03"
}

preset_journeys_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Request Body schema:
required
name
required
string <= 200 characters
description
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

preset_journeys_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Request Body schema:
name
string <= 200 characters
description
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

preset_journeys_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_dashboard_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_rename_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_upgrade_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this preset journey.

Responses

preset_journeys_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

reference-controls

reference_controls_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
category
Array of strings or null
Items Enum: "physical" "policy" "procedure" "process" "technical"
  • policy - Policy
  • process - Process
  • technical - Technical
  • physical - Physical
  • procedure - Procedure
csf_function
Array of strings or null
Items Enum: "detect" "govern" "identify" "protect" "recover" "respond"
  • govern - Govern
  • identify - Identify
  • protect - Protect
  • detect - Detect
  • respond - Respond
  • recover - Recover
filtering_labels
Array of strings <uuid> [ items <uuid > ]
findings
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

provider
string
search
string

A search term.

urn
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

reference_controls_create

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
(Category3aaEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
(CsfFunctionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
typical_evidence
any or null
is_published
boolean (Published)
folder
string <uuid>
library
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

reference_controls_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "path": "string",
  • "folder": "string",
  • "library": "string",
  • "filtering_labels": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true
}

reference_controls_update

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
(Category3aaEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
(CsfFunctionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
typical_evidence
any or null
is_published
boolean (Published)
folder
string <uuid>
library
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

reference_controls_partial_update

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Request Body schema:
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
locale
string <= 100 characters
default_locale
boolean
(Category3aaEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
(CsfFunctionEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
typical_evidence
any or null
is_published
boolean (Published)
folder
string <uuid>
library
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locale": "string",
  • "default_locale": true,
  • "category": "policy",
  • "csf_function": "govern",
  • "typical_evidence": null,
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "filtering_labels": [
    ]
}

reference_controls_destroy

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

reference_controls_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

reference_controls_object_retrieve

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

reference_controls_sync_applied_controls_create

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

reference_controls_syncable_applied_controls_retrieve

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Reference control.

Responses

reference_controls_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

reference_controls_category_retrieve

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken

Responses

reference_controls_csf_function_retrieve

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken

Responses

reference_controls_provider_retrieve

API endpoint that allows reference controls to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement-mapping-sets

requirement_mapping_sets_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

provider
string
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

requirement_mapping_sets_create

Authorizations:
knoxApiToken
Request Body schema:
name
string or null <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
builtin
boolean
locale
string <= 100 characters
default_locale
boolean
is_published
boolean (Published)
translations
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null
}

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Request Body schema:
name
string or null <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
builtin
boolean
locale
string <= 100 characters
default_locale
boolean
is_published
boolean (Published)
translations
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null
}

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Request Body schema:
name
string or null <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
builtin
boolean
locale
string <= 100 characters
default_locale
boolean
is_published
boolean (Published)
translations
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null
}

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Responses

requirement_mapping_sets_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_graph_data_retrieve_2

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this stored library.

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken
Request Body schema:
name
string or null <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
builtin
boolean
locale
string <= 100 characters
default_locale
boolean
is_published
boolean (Published)
translations
any or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null
}

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_graph_data_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement_mapping_sets_provider_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "source_framework": "string",
  • "target_framework": "string",
  • "folder": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "urn": "string",
  • "provider": "string",
  • "builtin": true,
  • "locale": "string",
  • "default_locale": true,
  • "is_published": true,
  • "translations": null,
  • "frameworks_available": "string"
}

requirement-nodes

requirement_nodes_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
framework
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

urn
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

requirement_nodes_create

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
translations
any or null
locale
string <= 100 characters
default_locale
boolean
parent_urn
string or null <= 255 characters
order_id
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups
any or null
assessable
required
boolean
typical_evidence
string or null
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
importance
string (ImportanceEnum)
Enum: "mandatory" "recommended" "nice_to_have" "undefined"
  • mandatory - Mandatory
  • recommended - Recommended
  • nice_to_have - Nice to have
  • undefined - Undefined
display_mode
string (DisplayModeEnum)
Enum: "default" "splash"
  • default - Default
  • splash - Splash screen
folder
string <uuid>
framework
string or null <uuid>
threats
Array of strings <uuid> [ items <uuid > ]
reference_controls
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

requirement_nodes_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "reference_controls": [
    ],
  • "threats": [
    ],
  • "display_short": "string",
  • "display_long": "string",
  • "questions": "string",
  • "typical_evidence": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596"
}

requirement_nodes_update

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Request Body schema:
required
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
translations
any or null
locale
string <= 100 characters
default_locale
boolean
parent_urn
string or null <= 255 characters
order_id
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups
any or null
assessable
required
boolean
typical_evidence
string or null
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
importance
string (ImportanceEnum)
Enum: "mandatory" "recommended" "nice_to_have" "undefined"
  • mandatory - Mandatory
  • recommended - Recommended
  • nice_to_have - Nice to have
  • undefined - Undefined
display_mode
string (DisplayModeEnum)
Enum: "default" "splash"
  • default - Default
  • splash - Splash screen
folder
string <uuid>
framework
string or null <uuid>
threats
Array of strings <uuid> [ items <uuid > ]
reference_controls
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

requirement_nodes_partial_update

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Request Body schema:
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
name
string or null <= 200 characters
description
string or null
annotation
string or null
translations
any or null
locale
string <= 100 characters
default_locale
boolean
parent_urn
string or null <= 255 characters
order_id
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
implementation_groups
any or null
assessable
boolean
typical_evidence
string or null
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
importance
string (ImportanceEnum)
Enum: "mandatory" "recommended" "nice_to_have" "undefined"
  • mandatory - Mandatory
  • recommended - Recommended
  • nice_to_have - Nice to have
  • undefined - Undefined
display_mode
string (DisplayModeEnum)
Enum: "default" "splash"
  • default - Default
  • splash - Splash screen
folder
string <uuid>
framework
string or null <uuid>
threats
Array of strings <uuid> [ items <uuid > ]
reference_controls
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "translations": null,
  • "locale": "string",
  • "default_locale": true,
  • "parent_urn": "string",
  • "order_id": -9223372036854776000,
  • "implementation_groups": null,
  • "assessable": true,
  • "typical_evidence": "string",
  • "weight": -9223372036854776000,
  • "importance": "mandatory",
  • "display_mode": "default",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "threats": [
    ],
  • "reference_controls": [
    ]
}

requirement_nodes_destroy

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_inspect_requirement_retrieve

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_object_retrieve

API endpoint that allows requirements to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_serve_image_retrieve

Serve an image attachment belonging to this requirement node.

Authorizations:
knoxApiToken
path Parameters
attachment_id
required
string^[0-9a-f-]+$
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_upload_image_create

Upload an image file and attach it to this requirement node.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RequirementNode.

Responses

requirement_nodes_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

stored-libraries

stored_libraries_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
filtering_labels
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_custom
boolean
is_loaded
boolean
is_preset
boolean
is_update
boolean
limit
integer

Number of results to return per page.

locale
Array of strings
Items Enum: "ar" "cs" "da" "de" "el" "en" "es" "fr" "hi" "hr" "hu" "id" "it" "ko" "lt" "nl" "pl" "pt" "ro" "sv" "tr" "uk" "ur" "zh"
  • en - en
  • fr - fr
  • es - es
  • de - de
  • it - it
  • nl - nl
  • pl - pl
  • pt - pt
  • ar - ar
  • ro - ro
  • hi - hi
  • ur - ur
  • cs - cs
  • sv - sv
  • id - id
  • da - da
  • hu - hu
  • uk - uk
  • el - el
  • tr - tr
  • hr - hr
  • zh - zh
  • lt - lt
  • ko - ko
object_type
Array of strings
Items Enum: "framework" "frameworks" "metric_definitions" "reference_controls" "requirement_mapping_set" "requirement_mapping_sets" "risk_matrices" "risk_matrix" "threats"
  • threats - threats
  • reference_controls - reference_controls
  • metric_definitions - metric_definitions
  • risk_matrix - risk_matrix
  • risk_matrices - risk_matrices
  • framework - framework
  • frameworks - frameworks
  • requirement_mapping_set - requirement_mapping_set
  • requirement_mapping_sets - requirement_mapping_sets
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

packager
string
provider
string
search
string

A search term.

urn
string
version
integer

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

stored_libraries_create

Authorizations:
knoxApiToken
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_update

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema: */*
name
string
description
string or null
annotation
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
string <= 64 characters
content
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

stored_libraries_apply_create

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema: application/json
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_content_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_import_create

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_tree_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_unload_create

Authorizations:
knoxApiToken
path Parameters
id
required
string^[\w.:-]+$
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_locale_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_object_type_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_provider_retrieve

Authorizations:
knoxApiToken

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

stored_libraries_upload_create

Authorizations:
knoxApiToken
Request Body schema: */*
required
name
required
string
description
required
string or null
annotation
required
string or null
is_published
boolean (Published)
ref_id
string or null (Reference ID) <= 100 characters
provider
string or null <= 200 characters
locale
string <= 100 characters
Default: "en"
default_locale
boolean
urn
string or null <= 255 characters
copyright
string or null <= 4096 characters
version
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
packager
string or null <= 100 characters

Packager of the library

publication_date
string or null <date>
builtin
boolean
objects_meta
any
dependencies
any or null
is_loaded
boolean
hash_checksum
required
string <= 64 characters
content
required
any
autoload
boolean

If set to true, the library will be automatically loaded on migrate.

folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "locales": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "en",
  • "default_locale": true,
  • "urn": "string",
  • "copyright": "string",
  • "version": -9223372036854776000,
  • "packager": "string",
  • "publication_date": "2019-08-24",
  • "builtin": true,
  • "objects_meta": null,
  • "dependencies": null,
  • "is_loaded": true,
  • "hash_checksum": "string",
  • "content": null,
  • "autoload": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}