API docs by Redocly

CISO Assistant API — Integrations & Tooling (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

accreditations

pmbok_accreditations_list

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

Authorizations:
knoxApiToken
query Parameters
author
Array of strings <uuid> [ items <uuid > ]
authority
Array of strings <uuid> [ items <uuid > ]
category
Array of strings <uuid> [ items <uuid > ]
checklist
Array of strings <uuid> [ items <uuid > ]
filtering_labels
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.

linked_collection
Array of strings <uuid> [ items <uuid > ]
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 <uuid> [ items <uuid > ]

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": [
    ]
}

pmbok_accreditations_create

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
authority_name
string <= 200 characters

Free-text authority name, for authorities not registered as entities

expiry_date
string or null <date>
commission_date
string or null <date>

Date of the accreditation commission decision

duration_months
integer or null <int64> [ 0 .. 9223372036854776000 ]

Accreditation validity duration in months

observation
string or null
folder
string <uuid>
category
required
string <uuid>
authority
string or null <uuid>

Accreditation authority entity

status
required
string <uuid>
author
string or null <uuid>
linked_collection
string or null <uuid>
checklist
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
decision_evidence
Array of strings <uuid> [ items <uuid > ]

Evidence documents for the accreditation decision (e.g. minutes/PV)

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

pmbok_accreditations_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this accreditation.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "folder": "string",
  • "author": "string",
  • "authority": "string",
  • "linked_collection": "string",
  • "collection_data": "string",
  • "checklist": "string",
  • "decision_evidence": [
    ],
  • "filtering_labels": [
    ],
  • "status": "string",
  • "category": "string",
  • "checklist_progress": "string",
  • "validation_flows": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string"
}

pmbok_accreditations_update

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this accreditation.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
authority_name
string <= 200 characters

Free-text authority name, for authorities not registered as entities

expiry_date
string or null <date>
commission_date
string or null <date>

Date of the accreditation commission decision

duration_months
integer or null <int64> [ 0 .. 9223372036854776000 ]

Accreditation validity duration in months

observation
string or null
folder
string <uuid>
category
required
string <uuid>
authority
string or null <uuid>

Accreditation authority entity

status
required
string <uuid>
author
string or null <uuid>
linked_collection
string or null <uuid>
checklist
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
decision_evidence
Array of strings <uuid> [ items <uuid > ]

Evidence documents for the accreditation decision (e.g. minutes/PV)

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

pmbok_accreditations_partial_update

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this accreditation.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
authority_name
string <= 200 characters

Free-text authority name, for authorities not registered as entities

expiry_date
string or null <date>
commission_date
string or null <date>

Date of the accreditation commission decision

duration_months
integer or null <int64> [ 0 .. 9223372036854776000 ]

Accreditation validity duration in months

observation
string or null
folder
string <uuid>
category
string <uuid>
authority
string or null <uuid>

Accreditation authority entity

status
string <uuid>
author
string or null <uuid>
linked_collection
string or null <uuid>
checklist
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
decision_evidence
Array of strings <uuid> [ items <uuid > ]

Evidence documents for the accreditation decision (e.g. minutes/PV)

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "authority_name": "string",
  • "expiry_date": "2019-08-24",
  • "commission_date": "2019-08-24",
  • "duration_months": 9223372036854776000,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "authority": "993388dc-6010-423f-9621-668306c2901a",
  • "status": "82eda2a6-0a31-45ba-9c43-cfddbcb85a6d",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "linked_collection": "6b2cbc25-6f39-4099-aa2c-50eec3fe902e",
  • "checklist": "9a472e43-bbf3-4d3d-88fa-f51774d94610",
  • "filtering_labels": [
    ],
  • "decision_evidence": [
    ]
}

pmbok_accreditations_destroy

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this accreditation.

Responses

pmbok_accreditations_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 accreditation.

Responses

pmbok_accreditations_object_retrieve

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this accreditation.

Responses

pmbok_accreditations_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

pmbok_accreditations_category_retrieve

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken

Responses

pmbok_accreditations_status_retrieve

API endpoint that allows accreditations to be viewed or edited.

Authorizations:
knoxApiToken

Responses

chat

chat_documents_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.

source_type
Array of strings
Items Enum: "chat" "custom" "evidence"
  • chat - Chat upload
  • evidence - Evidence attachment
  • custom - Custom upload
status
Array of strings
Items Enum: "failed" "indexed" "pending" "processing"
  • pending - Pending
  • processing - Processing
  • indexed - Indexed
  • failed - Failed

Responses

Response samples

Content type
application/json
{}

chat_documents_create

ViewSet for managing indexed documents.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
file
required
string <uri>
filename
required
string <= 255 characters
content_type
required
string <= 100 characters
source_type
required
string (SourceTypeEnum)
Enum: "chat" "evidence" "custom"
  • chat - Chat upload
  • evidence - Evidence attachment
  • custom - Custom upload
source_object_id
string or null <uuid>
folder
string <uuid>
source_content_type
integer or null

Responses

Request samples

Content type
{
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

chat_documents_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Indexed document.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "status": "pending",
  • "chunk_count": -9223372036854776000,
  • "error_message": "string",
  • "indexed_at": "2019-08-24T14:15:22Z",
  • "source_content_type": 0
}

chat_documents_update

ViewSet for managing indexed documents.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Indexed document.

Request Body schema:
required
is_published
boolean (Published)
file
required
string <uri>
filename
required
string <= 255 characters
content_type
required
string <= 100 characters
source_type
required
string (SourceTypeEnum)
Enum: "chat" "evidence" "custom"
  • chat - Chat upload
  • evidence - Evidence attachment
  • custom - Custom upload
source_object_id
string or null <uuid>
folder
string <uuid>
source_content_type
integer or null

Responses

Request samples

Content type
{
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

chat_documents_partial_update

ViewSet for managing indexed documents.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Indexed document.

Request Body schema:
is_published
boolean (Published)
file
string <uri>
filename
string <= 255 characters
content_type
string <= 100 characters
source_type
string (SourceTypeEnum)
Enum: "chat" "evidence" "custom"
  • chat - Chat upload
  • evidence - Evidence attachment
  • custom - Custom upload
source_object_id
string or null <uuid>
folder
string <uuid>
source_content_type
integer or null

Responses

Request samples

Content type
{
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "file": "http://example.com",
  • "filename": "string",
  • "content_type": "string",
  • "source_type": "chat",
  • "source_object_id": "558391d4-bb80-44b3-b320-6c3f1de9da84",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "source_content_type": 0
}

chat_documents_destroy

ViewSet for managing indexed documents.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Indexed document.

Responses

chat_documents_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 Indexed document.

Responses

chat_documents_object_retrieve

ViewSet for managing indexed documents.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Indexed document.

Responses

chat_documents_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

chat_ollama_models_retrieve

List available models from the Ollama server.

Authorizations:
knoxApiToken

Responses

chat_sessions_list

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

Authorizations:
knoxApiToken
query Parameters
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": [
    ]
}

chat_sessions_create

ViewSet for chat sessions with streaming message endpoint.

Authorizations:
knoxApiToken
Request Body schema:
is_published
boolean (Published)
title
string <= 200 characters
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

chat_sessions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "owner": "string",
  • "messages": [
    ],
  • "message_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "title": "string",
  • "workflow_state": null
}

chat_sessions_update

ViewSet for chat sessions with streaming message endpoint.

Authorizations:
knoxApiToken
path Parameters
id
required
string
Request Body schema:
is_published
boolean (Published)
title
string <= 200 characters
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

chat_sessions_partial_update

ViewSet for chat sessions with streaming message endpoint.

Authorizations:
knoxApiToken
path Parameters
id
required
string
Request Body schema:
is_published
boolean (Published)
title
string <= 200 characters
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "title": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

chat_sessions_destroy

ViewSet for chat sessions with streaming message endpoint.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

chat_sessions_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

Responses

chat_sessions_message_create

Send a message and get a streaming SSE response. The response includes RAG retrieval + LLM generation.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

chat_sessions_object_retrieve

ViewSet for chat sessions with streaming message endpoint.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

chat_sessions_upload_create

Upload a document to be indexed for RAG in this session's folder context.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

chat_sessions_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

chat_status_retrieve

Check chat service health: Ollama availability, index status.

Authorizations:
knoxApiToken

Responses

content-types

content_types_retrieve

Authorizations:
knoxApiToken

Responses

data-wizard

data_wizard_load_file_create

Authorizations:
knoxApiToken
Request Body schema: */*
required
file
required
string <uri>

File to be processed (.xlsx, .xls, .csv)

Responses

Response samples

Content type
application/json
{}

generic-collections

pmbok_generic_collections_list

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

Authorizations:
knoxApiToken
query Parameters
compliance_assessments
Array of strings <uuid> [ items <uuid > ]
crq_studies
Array of strings <uuid> [ items <uuid > ]
documents
Array of strings <uuid> [ items <uuid > ]
ebios_studies
Array of strings <uuid> [ items <uuid > ]
entity_assessments
Array of strings <uuid> [ items <uuid > ]
filtering_labels
Array of strings <uuid> [ items <uuid > ]
findings_assessments
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.

policies
Array of strings <uuid> [ items <uuid > ]
risk_assessments
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

security_exceptions
Array of strings <uuid> [ items <uuid > ]

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": [
    ]
}

pmbok_generic_collections_create

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
compliance_assessments
Array of strings <uuid> [ items <uuid > ]
risk_assessments
Array of strings <uuid> [ items <uuid > ]
crq_studies
Array of strings <uuid> [ items <uuid > ]
ebios_studies
Array of strings <uuid> [ items <uuid > ]
entity_assessments
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
documents
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
policies
Array of strings <uuid> [ items <uuid > ]
dependencies
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

pmbok_generic_collections_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this generic collection.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "folder": "string",
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ],
  • "filtering_labels": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string"
}

pmbok_generic_collections_update

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this generic collection.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
compliance_assessments
Array of strings <uuid> [ items <uuid > ]
risk_assessments
Array of strings <uuid> [ items <uuid > ]
crq_studies
Array of strings <uuid> [ items <uuid > ]
ebios_studies
Array of strings <uuid> [ items <uuid > ]
entity_assessments
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
documents
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
policies
Array of strings <uuid> [ items <uuid > ]
dependencies
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

pmbok_generic_collections_partial_update

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this generic collection.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
compliance_assessments
Array of strings <uuid> [ items <uuid > ]
risk_assessments
Array of strings <uuid> [ items <uuid > ]
crq_studies
Array of strings <uuid> [ items <uuid > ]
ebios_studies
Array of strings <uuid> [ items <uuid > ]
entity_assessments
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
documents
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
policies
Array of strings <uuid> [ items <uuid > ]
dependencies
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

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",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "crq_studies": [
    ],
  • "ebios_studies": [
    ],
  • "entity_assessments": [
    ],
  • "findings_assessments": [
    ],
  • "documents": [
    ],
  • "security_exceptions": [
    ],
  • "policies": [
    ],
  • "dependencies": [
    ]
}

pmbok_generic_collections_destroy

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this generic collection.

Responses

pmbok_generic_collections_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 generic collection.

Responses

pmbok_generic_collections_object_retrieve

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this generic collection.

Responses

pmbok_generic_collections_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

pmbok_generic_collections_status_retrieve

API endpoint that allows generic collections to be viewed or edited.

Authorizations:
knoxApiToken

Responses

integrations

integrations_configs_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
Array of strings <uuid> [ items <uuid > ]
provider__name
string
provider__provider_type
Array of strings
Items Value: "itsm"
  • itsm - Itsm
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

integrations_configs_create

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
Request Body schema:
required
provider_id
required
string <uuid>
folder_id
required
string <uuid>
credentials
any
settings
any
is_active
boolean
webhook_secret
string

Responses

Request samples

Content type
{
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "webhook_secret": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "string",
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "last_sync_at": "2019-08-24T14:15:22Z",
  • "webhook_url_full": "string",
  • "has_api_token": true,
  • "has_webhook_secret": true
}

integrations_configs_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "string",
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "last_sync_at": "2019-08-24T14:15:22Z",
  • "webhook_url_full": "string",
  • "has_api_token": true,
  • "has_webhook_secret": true
}

integrations_configs_update

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Request Body schema:
required
provider_id
required
string <uuid>
folder_id
required
string <uuid>
credentials
any
settings
any
is_active
boolean
webhook_secret
string

Responses

Request samples

Content type
{
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "webhook_secret": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "string",
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "last_sync_at": "2019-08-24T14:15:22Z",
  • "webhook_url_full": "string",
  • "has_api_token": true,
  • "has_webhook_secret": true
}

integrations_configs_partial_update

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Request Body schema:
provider_id
string <uuid>
folder_id
string <uuid>
credentials
any
settings
any
is_active
boolean
webhook_secret
string

Responses

Request samples

Content type
{
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "webhook_secret": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "provider": "string",
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "folder": "string",
  • "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901",
  • "credentials": null,
  • "settings": null,
  • "is_active": true,
  • "last_sync_at": "2019-08-24T14:15:22Z",
  • "webhook_url_full": "string",
  • "has_api_token": true,
  • "has_webhook_secret": true
}

integrations_configs_destroy

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

integrations_configs_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 integration configuration.

Responses

integrations_configs_object_retrieve

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

integrations_configs_remote_objects_retrieve

API endpoint for creating, viewing, updating, and deleting Integration Configurations.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

integrations_configs_rpc_create

Generic endpoint for interactive integration commands. Payload: { "action": "get_tables", "params": { ... } }

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

integrations_configs_test_connection_create

Custom action to test the connection for a saved integration configuration. URL: /api/integrations/configs/{id}/test-connection/

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this integration configuration.

Responses

integrations_configs_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

integrations_providers_list

An API endpoint to list all available (and active) Integration Providers.

Authorizations:
knoxApiToken
query Parameters
limit
integer

Number of results to return per page.

name
string
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

provider_type
string
Value: "itsm"
  • itsm - Itsm
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

integrations_sync_mappings_destroy

An API endpoint to delete a SyncMapping.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

Responses

integrations_test_connection_create

An endpoint to test connection credentials without saving them. Accepts a POST request with provider_id and credentials.

Authorizations:
knoxApiToken

Responses

search

search_retrieve

Universal fuzzy search across all searchable models.

GET /api/search/?q=firewall+policy&type=applied-controls,assets

Authorizations:
knoxApiToken

Responses

serdes

serdes_attachment_metadata_retrieve

GET endpoint that returns paginated metadata for all attachments. Supports filtering by folder, created_after, and created_before.

Authorizations:
knoxApiToken

Responses

serdes_batch_download_attachments_create

POST endpoint that streams multiple attachments in a custom binary format. Request body: {"revision_ids": ["id1", "id2", ...]} Response format: for each file: [4-byte length][JSON header][file bytes]

Authorizations:
knoxApiToken

Responses

serdes_batch_upload_attachments_create

POST endpoint that accepts multiple attachments in custom binary format. Request body: same format as batch download (4-byte length, JSON header, file bytes) Response: {"processed": N, "restored": N, "skipped": N, "errors": [...]}

Authorizations:
knoxApiToken

Responses

serdes_dump_db_retrieve

Authorizations:
knoxApiToken

Responses

serdes_full_restore_create

POST endpoint for atomic database + attachments restore. Accepts multipart form data with:

  • backup: database backup file (required)
  • attachments: streaming binary data in custom format (optional)

This ensures both operations happen in a single authenticated request, avoiding token invalidation issues.

Authorizations:
knoxApiToken

Responses

serdes_load_backup_create

Authorizations:
knoxApiToken

Responses

webhooks

webhooks_endpoints_list

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

Authorizations:
knoxApiToken
query Parameters
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
{}

webhooks_endpoints_create

API endpoint to create, list, retrieve, update, and delete Webhook Endpoints.

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string <= 200 characters
description
string or null
payload_format
string
Enum: "thin" "full"

The format of the webhook payload sent to this endpoint.

  • thin - Thin
  • full - Full
url
required
string <uri> <= 512 characters

The consumer URL to send webhook events to.

event_types
Array of strings
is_active
boolean

Global toggle to enable/disable sending events to this endpoint.

secret
string

HMAC signing secret

target_folders
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "secret": "string",
  • "target_folders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_update

API endpoint to create, list, retrieve, update, and delete Webhook Endpoints.

Authorizations:
knoxApiToken
path Parameters
id
required
string
Request Body schema:
required
name
required
string <= 200 characters
description
string or null
payload_format
string
Enum: "thin" "full"

The format of the webhook payload sent to this endpoint.

  • thin - Thin
  • full - Full
url
required
string <uri> <= 512 characters

The consumer URL to send webhook events to.

event_types
Array of strings
is_active
boolean

Global toggle to enable/disable sending events to this endpoint.

secret
string

HMAC signing secret

target_folders
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "secret": "string",
  • "target_folders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_partial_update

API endpoint to create, list, retrieve, update, and delete Webhook Endpoints.

Authorizations:
knoxApiToken
path Parameters
id
required
string
Request Body schema:
name
string <= 200 characters
description
string or null
payload_format
string
Enum: "thin" "full"

The format of the webhook payload sent to this endpoint.

  • thin - Thin
  • full - Full
url
string <uri> <= 512 characters

The consumer URL to send webhook events to.

event_types
Array of strings
is_active
boolean

Global toggle to enable/disable sending events to this endpoint.

secret
string

HMAC signing secret

target_folders
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "secret": "string",
  • "target_folders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_destroy

API endpoint to create, list, retrieve, update, and delete Webhook Endpoints.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

webhooks_endpoints_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

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_object_retrieve

API endpoint to create, list, retrieve, update, and delete Webhook Endpoints.

Authorizations:
knoxApiToken
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_endpoints_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 <= 200 characters
description
string or null
payload_format
string
Enum: "thin" "full"

The format of the webhook payload sent to this endpoint.

  • thin - Thin
  • full - Full
url
required
string <uri> <= 512 characters

The consumer URL to send webhook events to.

event_types
Array of strings
is_active
boolean

Global toggle to enable/disable sending events to this endpoint.

secret
string

HMAC signing secret

target_folders
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "secret": "string",
  • "target_folders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "payload_format": "thin",
  • "url": "http://example.com",
  • "event_types": [
    ],
  • "is_active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "has_secret": "string",
  • "target_folders": [
    ]
}

webhooks_event_types_retrieve

Returns a list of all registered event type strings.

Authorizations:
knoxApiToken

Responses