API docs by Redocly

CISO Assistant API — Assets (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

asset-capabilities

asset_capabilities_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
{}

asset_capabilities_create

Authorizations:
knoxApiToken
Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
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
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "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,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

asset_capabilities_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset Capability.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "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,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

asset_capabilities_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset Capability.

Request Body schema:
required
name
required
string
description
required
string or null
annotation
required
string or null
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
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "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,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

asset_capabilities_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset Capability.

Request Body schema:
name
string
description
string or null
annotation
string or null
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
locale
string <= 100 characters
default_locale
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "annotation": "string",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "provider": "string",
  • "locale": "string",
  • "default_locale": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "annotation": "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,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

asset_capabilities_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset Capability.

Responses

asset_capabilities_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 Asset Capability.

Responses

asset_capabilities_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset Capability.

Responses

asset_capabilities_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

asset-class

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

parent
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

asset_class_create

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

asset_class_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset class.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "parent": "string",
  • "full_path": "string",
  • "name": "string",
  • "description": "string"
}

asset_class_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset class.

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

asset_class_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset class.

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

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999"
}

asset_class_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset class.

Responses

asset_class_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 asset class.

Responses

asset_class_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset class.

Responses

asset_class_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

asset_class_tree_retrieve

Authorizations:
knoxApiToken

Responses

assets

assets_list

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

Authorizations:
knoxApiToken
query Parameters
applied_controls
Array of strings <uuid> [ items <uuid > ]
asset_class
Array of strings <uuid> [ items <uuid > ]
dora_criticality_assessment
Array of strings or null
Items Enum: "eba_BT:x21" "eba_BT:x28" "eba_BT:x29"
  • eba_BT:x28 - Yes
  • eba_BT:x29 - No
  • eba_BT:x21 - Assessment not performed
dora_discontinuing_impact
Array of strings or null
Items Enum: "eba_ZZ:x791" "eba_ZZ:x792" "eba_ZZ:x793" "eba_ZZ:x799"
  • eba_ZZ:x791 - Low
  • eba_ZZ:x792 - Medium
  • eba_ZZ:x793 - High
  • eba_ZZ:x799 - Assessment not performed
dora_licenced_activity
Array of strings or null (DORA Licensed Activity)
Items Enum: "eba_TA:qx277" "eba_TA:qx278" "eba_TA:x104" "eba_TA:x133" "eba_TA:x134" "eba_TA:x136" "eba_TA:x137" "eba_TA:x138" "eba_TA:x139" "eba_TA:x140" "eba_TA:x141" "eba_TA:x143" "eba_TA:x144" "eba_TA:x146" "eba_TA:x147" "eba_TA:x162" "eba_TA:x163" "eba_TA:x164" "eba_TA:x165" "eba_TA:x166" "eba_TA:x167" "eba_TA:x168" "eba_TA:x169" "eba_TA:x170" "eba_TA:x171" "eba_TA:x172" "eba_TA:x173" "eba_TA:x174" "eba_TA:x175" "eba_TA:x176" "eba_TA:x177" "eba_TA:x178" "eba_TA:x179" "eba_TA:x180" "eba_TA:x181" "eba_TA:x182" "eba_TA:x183" "eba_TA:x184" "eba_TA:x185" "eba_TA:x186" "eba_TA:x187" "eba_TA:x188" "eba_TA:x189" "eba_TA:x190" "eba_TA:x191" "eba_TA:x192" "eba_TA:x193" "eba_TA:x194" "eba_TA:x195" "eba_TA:x196" "eba_TA:x197" "eba_TA:x198" "eba_TA:x199" "eba_TA:x200" "eba_TA:x201" "eba_TA:x202" "eba_TA:x203" "eba_TA:x204" "eba_TA:x205" "eba_TA:x206" "eba_TA:x207" "eba_TA:x208" "eba_TA:x209" "eba_TA:x210" "eba_TA:x211" "eba_TA:x212" "eba_TA:x213" "eba_TA:x214" "eba_TA:x215" "eba_TA:x216" "eba_TA:x217" "eba_TA:x218" "eba_TA:x219" "eba_TA:x220" "eba_TA:x221" "eba_TA:x222" "eba_TA:x223" "eba_TA:x224" "eba_TA:x225" "eba_TA:x226" "eba_TA:x227" "eba_TA:x228" "eba_TA:x229" "eba_TA:x230" "eba_TA:x231" "eba_TA:x232" "eba_TA:x233" "eba_TA:x234" "eba_TA:x235" "eba_TA:x236" "eba_TA:x237" "eba_TA:x238" "eba_TA:x239" "eba_TA:x240" "eba_TA:x241" "eba_TA:x242" "eba_TA:x243" "eba_TA:x244" "eba_TA:x245" "eba_TA:x246" "eba_TA:x247" "eba_TA:x248" "eba_TA:x249" "eba_TA:x250" "eba_TA:x251" "eba_TA:x252" "eba_TA:x253" "eba_TA:x254" "eba_TA:x255" "eba_TA:x256" "eba_TA:x257" "eba_TA:x258" "eba_TA:x259" "eba_TA:x260" "eba_TA:x261" "eba_TA:x262" "eba_TA:x263" "eba_TA:x264" "eba_TA:x265" "eba_TA:x266" "eba_TA:x267" "eba_TA:x268" "eba_TA:x269" "eba_TA:x270" "eba_TA:x271" "eba_TA:x272" "eba_TA:x273" "eba_TA:x274" "eba_TA:x275" "eba_TA:x276" "eba_TA:x28"
  • eba_TA:x185 - Non-Life Insurance: Classes 1 and 2: 'Accident and Health Insurance'
  • eba_TA:x186 - Non-Life Insurance: Classes 1 (fourth indent), 3, 7 and 10: 'Motor Insurance'
  • eba_TA:x187 - Non-Life Insurance: Classes 1 (fourth indent), 4, 6, 7 and 12: 'Marine and Transport Insurance'
  • eba_TA:x188 - Non-Life Insurance: Classes 1 (fourth indent), 5, 7 and 11: 'Aviation Insurance'
  • eba_TA:x189 - Non-Life Insurance: Classes 8 and 9: 'Insurance against Fire and other Damage to Property'
  • eba_TA:x190 - Non-Life Insurance: Classes 10, 11, 12 and 13: 'Liability Insurance'
  • eba_TA:x191 - Non-Life Insurance: Classes 14 and 15: 'Credit and Suretyship Insurance'
  • eba_TA:x192 - Non-Life Insurance: All classes, at the choice of the Member States, which shall notify the other Member States and the Commission of their choice
  • eba_TA:x193 - Life Insurance: The life insurance referred to in points (a)(i), (ii) and (iii) of Article 2(3) excluding those referred to in II and III
  • eba_TA:x194 - Life Insurance: Marriage assurance, birth assurance
  • eba_TA:x195 - Life Insurance: The insurance referred to in points (a)(i) and (ii) of Article 2(3), which are linked to investment funds
  • eba_TA:x196 - Life Insurance: Permanent health insurance, referred to in point (a)(iv) of Article 2(3)
  • eba_TA:x197 - Life Insurance: Tontines, referred to in point (b)(i) of Article 2(3)
  • eba_TA:x198 - Life Insurance: Capital redemption operations, referred to in point (b)(ii) of Article 2(3)
  • eba_TA:x199 - Life Insurance: Management of group pension funds, referred to in point (b)(iii) and (iv) of Article 2(3)
  • eba_TA:x200 - Life Insurance: The operations referred to in point (b)(v) of Article 2(3)
  • eba_TA:x201 - Life Insurance: The operations referred to in Article 2(3)(c)
  • eba_TA:x163 - Lending activities
  • eba_TA:x164 - Financial leasing
  • eba_TA:x165 - Issuing and administering other means of payment
  • eba_TA:x166 - Guarantees and commitments
  • eba_TA:x167 - Guarantees and commitments related to securities lending and borrowing, within the meaning of point 6 of Annex I to Directive 2013/36/EU
  • eba_TA:x168 - Trading for own account or for account of customers
  • eba_TA:x169 - Participation in securities issues and the provision of services relating to such issues
  • eba_TA:x28 - Payment services
  • eba_TA:x170 - Advisory services
  • eba_TA:x171 - Money broking
  • eba_TA:x172 - Portfolio management and advice
  • eba_TA:x173 - Dealing on own account
  • eba_TA:x174 - Safekeeping and administration of securities
  • eba_TA:x175 - Safekeeping and administration of financial instruments for the account of clients
  • eba_TA:x176 - safe-keeping and administration in relation to shares or units of collective investment undertakings
  • eba_TA:x177 - non-core services (safekeeping and administration in relation to units of collective investment undertakings)
  • eba_TA:x178 - Safe custody services
  • eba_TA:x179 - Credit reference services
  • eba_TA:x180 - Issuing electronic money
  • eba_TA:x181 - reception and transmission of orders for crypto-assets on behalf of clients
  • eba_TA:x182 - Portfolio management on crypto-assets
  • eba_TA:x183 - management of portfolios of investments (AIFMD)
  • eba_TA:x184 - management of portfolios of investments (UCITSD)
  • eba_TA:x202 - insurance distribution
  • eba_TA:x203 - reinsurance distribution
  • eba_TA:x204 - Investment services related to the underlying of the derivatives
  • eba_TA:x205 - Retirement-benefit related operations and activities arising therefrom
  • eba_TA:x206 - issuance of credit ratings
  • eba_TA:x207 - administering the arrangements for determining a benchmark
  • eba_TA:x208 - collecting, analysing or processing input data for the purpose of determining a benchmark
  • eba_TA:x209 - determining a benchmark through the application of a formula or other method of calculation or by an assessment of input data provided for that purpose
  • eba_TA:x210 - publication of benchmark
  • eba_TA:x211 - Provision of crowdfunding services
  • eba_TA:x212 - ancillary non-securitisation services
  • eba_TA:x213 - ancillary securitisation services
  • eba_TA:x214 - collection and maintenance of the records of derivatives (non-SFTs)
  • eba_TA:x215 - collection and maintenance of the records of SFTs
  • eba_TA:x216 - collection and maintenance of the records of securitisations
  • eba_TA:x217 - activity as approved publication arrangement
  • eba_TA:x218 - activity as consolidated tape provider
  • eba_TA:x219 - activity as approved reporting mechanism
  • eba_TA:x220 - Services enabling cash to be placed on a payment account as well as all the operations required for operating a payment account
  • eba_TA:x221 - Services enabling cash withdrawals from a payment account as well as all the operations required for operating a payment account
  • eba_TA:x222 - Execution of payment transactions, including transfers of funds on a payment account with the user's payment service provider or with another payment service provider
  • eba_TA:x223 - Execution of payment transactions where the funds are covered by a credit line for a payment service user
  • eba_TA:x224 - Issuing of payment instruments and/or acquiring of payment transactions
  • eba_TA:x225 - Money remittance
  • eba_TA:x226 - Payment initiation services
  • eba_TA:x227 - Account information services
  • eba_TA:x228 - Providing custody and administration of crypto-assets on behalf of clients
  • eba_TA:x229 - operation of a trading platform for crypto-assets
  • eba_TA:x230 - Operation of a Regulated Market
  • eba_TA:x231 - exchange of crypto-assets for funds
  • eba_TA:x232 - exchange of crypto-assets for other crypto-assets
  • eba_TA:x233 - execution of orders for crypto-assets on behalf of clients
  • eba_TA:x234 - placing of crypto-assets
  • eba_TA:x235 - providing advice on crypto-assets
  • eba_TA:x236 - providing transfer services for crypto-assets on behalf of clients
  • eba_TA:x237 - issuance of asset-referenced tokens
  • eba_TA:x238 - notary service
  • eba_TA:x239 - central maintenance service
  • eba_TA:x240 - settlement service
  • eba_TA:x241 - Organising a securities lending mechanism, as agent among participants of a securities settlement system
  • eba_TA:x242 - collateral management services
  • eba_TA:x243 - general collateral management services
  • eba_TA:x244 - Establishing CSD links, providing, maintaining or operating securities accounts in relation to the settlement service, collateral management, other ancillary services
  • eba_TA:x245 - Settlement matching, instruction routing, trade confirmation, trade verification
  • eba_TA:x246 - Services related to shareholders' registers
  • eba_TA:x247 - Supporting the processing of corporate actions, including tax, general meetings and information services
  • eba_TA:x248 - New issue services, including allocation and management of ISIN codes and similar codes
  • eba_TA:x249 - Instruction routing and processing, fee collection and processing and related reporting
  • eba_TA:x250 - Providing regulatory reporting
  • eba_TA:x251 - Providing information, data and statistics to market/census bureaus or other governmental or inter-governmental entities
  • eba_TA:x252 - Providing IT services
  • eba_TA:x253 - Providing cash accounts to, and accepting deposits from, participants in a securities settlement system and holders of securities accounts, within the meaning of point 1 of Annex I to Directive 2013/36/EU
  • eba_TA:x254 - Providing cash credit for reimbursement no later than the following business day, cash lending to pre-finance corporate actions and lending securities to holders of securities accounts, within the meaning of point 2 of Annex I to Directive 2013/36/EU
  • eba_TA:x255 - Payment services involving processing of cash and foreign exchange transactions, within the meaning of point 4 of Annex I to Directive 2013/36/EU
  • eba_TA:x256 - Treasury activities involving foreign exchange and transferable securities related to managing participants' long balances
  • eba_TA:x257 - Any other NCA-permitted non-banking-type ancillary services not specified in Annex of Regulation (EU) No 909/2014 (CSDR) - Section B
  • eba_TA:x258 - Any other NCA-permitted Banking-type ancillary services not specified in Annex of Regulation (EU) No 909/2014 (CSDR) - Section C
  • eba_TA:x259 - interposition between counterparties
  • eba_TA:x260 - risk management
  • eba_TA:x261 - legal and fund management accounting services
  • eba_TA:x262 - customer inquiries
  • eba_TA:x263 - valuation and pricing, including tax returns
  • eba_TA:x264 - regulatory compliance monitoring
  • eba_TA:x265 - maintenance of unit-/shareholder register
  • eba_TA:x266 - unit/shares issues and redemptions
  • eba_TA:x267 - maintenance of unit-holder register
  • eba_TA:x268 - unit issues and redemptions
  • eba_TA:x269 - contract settlements (including certificate dispatch)
  • eba_TA:x270 - distribution of income
  • eba_TA:x271 - record keeping
  • eba_TA:x272 - Marketing
  • eba_TA:x273 - services necessary to meet the fiduciary duties of the AIFM
  • eba_TA:x274 - investment advice concerning one or more of the instruments listed in Annex I, Section C to Directive 2004/39/EC
  • eba_TA:x275 - Ancillary services
  • eba_TA:x276 - supporting function
  • eba_TA:qx277 - Non-life reinsurance activities
  • eba_TA:qx278 - Life-reinsurance activities
  • eba_TA:x104 - Foreign exchange services
  • eba_TA:x133 - Reception and transmission of orders
  • eba_TA:x134 - Execution of orders on behalf of clients
  • eba_TA:x136 - Portfolio management
  • eba_TA:x137 - Investment advice
  • eba_TA:x138 - Underwriting of financial instruments and/or placing of financial instruments on a firm commitment basis
  • eba_TA:x139 - Placing of financial instruments without a firm commitment basis
  • eba_TA:x140 - Operation of an MTF
  • eba_TA:x141 - Operation of an OTF
  • eba_TA:x143 - Granting credits or loans to investors
  • eba_TA:x144 - Advice to undertakings on capital structure, industrial strategy and related matters and advice and services relating to mergers and the purchase of undertakings
  • eba_TA:x146 - Investment research and financial analysis
  • eba_TA:x147 - Services related to underwriting
  • eba_TA:x162 - Taking deposits and other repayable funds
ebios_rm_studies
Array of strings <uuid> [ items <uuid > ]
exclude_children
string

Exclude children

exclude_parents
string

Exclude parents

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.

is_business_function
boolean
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.

organisation_objectives
Array of strings <uuid> [ items <uuid > ]
parent_assets
Array of strings <uuid> [ items <uuid > ]
personal_data
Array of strings <uuid> [ items <uuid > ]
risk_scenarios
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

security_exceptions
Array of strings <uuid> [ items <uuid > ]
type
Array of strings
Items Enum: "PR" "SP"
  • PR - Primary
  • SP - Support

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

assets_create

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
parent_assets
Array of strings <uuid> [ items <uuid > ]
support_assets
Array of strings <uuid> [ items <uuid > ]
solutions
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
vulnerabilities
Array of strings <uuid> [ items <uuid > ]
incidents
Array of strings <uuid> [ items <uuid > ]
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
name
required
string <= 200 characters
description
string or null
type
string (AssetWriteTypeEnum)
Enum: "PR" "SP"
  • PR - Primary
  • SP - Support
reference_link
string or null <uri> (Link) <= 2048 characters

External url for action follow-up (eg. Jira ticket)

security_objectives
any

The security objectives of the asset

disaster_recovery_objectives
any

The disaster recovery objectives of the asset

security_capabilities
any

Actual security capabilities

recovery_capabilities
any (Recovery objectives)

Actual recovery objectives

ref_id
string (Reference ID) <= 100 characters
is_published
boolean (Published)
observation
string or null
is_business_function
boolean
(DoraLicencedActivityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) (DORA Licensed Activity)
(DoraCriticalityAssessmentEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
dora_criticality_justification
string or null
(DoraDiscontinuingImpactEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder
string <uuid>
asset_class
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
overridden_children_capabilities
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ebios_rm_studies": [
    ],
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

assets_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "path": "string",
  • "folder": "string",
  • "owner": [
    ],
  • "filtering_labels": [
    ],
  • "type": "string",
  • "personal_data": [
    ],
  • "asset_class": "string",
  • "overridden_children_capabilities": [
    ],
  • "children_assets": "string",
  • "security_objectives": "string",
  • "disaster_recovery_objectives": "string",
  • "security_capabilities": "string",
  • "recovery_capabilities": "string",
  • "security_objectives_comparison": "string",
  • "recovery_objectives_comparison": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "reference_link": "http://example.com",
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791"
}

assets_update

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset.

Request Body schema:
required
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
parent_assets
Array of strings <uuid> [ items <uuid > ]
support_assets
Array of strings <uuid> [ items <uuid > ]
solutions
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
vulnerabilities
Array of strings <uuid> [ items <uuid > ]
incidents
Array of strings <uuid> [ items <uuid > ]
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
name
required
string <= 200 characters
description
string or null
type
string (AssetWriteTypeEnum)
Enum: "PR" "SP"
  • PR - Primary
  • SP - Support
reference_link
string or null <uri> (Link) <= 2048 characters

External url for action follow-up (eg. Jira ticket)

security_objectives
any

The security objectives of the asset

disaster_recovery_objectives
any

The disaster recovery objectives of the asset

security_capabilities
any

Actual security capabilities

recovery_capabilities
any (Recovery objectives)

Actual recovery objectives

ref_id
string (Reference ID) <= 100 characters
is_published
boolean (Published)
observation
string or null
is_business_function
boolean
(DoraLicencedActivityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) (DORA Licensed Activity)
(DoraCriticalityAssessmentEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
dora_criticality_justification
string or null
(DoraDiscontinuingImpactEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder
string <uuid>
asset_class
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
overridden_children_capabilities
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ebios_rm_studies": [
    ],
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

assets_partial_update

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset.

Request Body schema:
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
parent_assets
Array of strings <uuid> [ items <uuid > ]
support_assets
Array of strings <uuid> [ items <uuid > ]
solutions
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
vulnerabilities
Array of strings <uuid> [ items <uuid > ]
incidents
Array of strings <uuid> [ items <uuid > ]
organisation_objectives
Array of strings <uuid> [ items <uuid > ]
name
string <= 200 characters
description
string or null
type
string (AssetWriteTypeEnum)
Enum: "PR" "SP"
  • PR - Primary
  • SP - Support
reference_link
string or null <uri> (Link) <= 2048 characters

External url for action follow-up (eg. Jira ticket)

security_objectives
any

The security objectives of the asset

disaster_recovery_objectives
any

The disaster recovery objectives of the asset

security_capabilities
any

Actual security capabilities

recovery_capabilities
any (Recovery objectives)

Actual recovery objectives

ref_id
string (Reference ID) <= 100 characters
is_published
boolean (Published)
observation
string or null
is_business_function
boolean
(DoraLicencedActivityEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) (DORA Licensed Activity)
(DoraCriticalityAssessmentEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
dora_criticality_justification
string or null
(DoraDiscontinuingImpactEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
folder
string <uuid>
asset_class
string or null <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]
overridden_children_capabilities
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "ebios_rm_studies": [
    ],
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent_assets": [
    ],
  • "support_assets": [
    ],
  • "solutions": [
    ],
  • "security_exceptions": [
    ],
  • "applied_controls": [
    ],
  • "vulnerabilities": [
    ],
  • "incidents": [
    ],
  • "organisation_objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "PR",
  • "reference_link": "http://example.com",
  • "security_objectives": null,
  • "disaster_recovery_objectives": null,
  • "security_capabilities": null,
  • "recovery_capabilities": null,
  • "ref_id": "string",
  • "is_published": true,
  • "observation": "string",
  • "is_business_function": true,
  • "dora_licenced_activity": "eba_TA:x185",
  • "dora_criticality_assessment": "eba_BT:x28",
  • "dora_criticality_justification": "string",
  • "dora_discontinuing_impact": "eba_ZZ:x791",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_class": "66ac577e-ce8a-4f2a-8fc8-4e6150364e46",
  • "filtering_labels": [
    ],
  • "overridden_children_capabilities": [
    ],
  • "owner": [
    ]
}

assets_destroy

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset.

Responses

assets_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 Asset.

Responses

assets_object_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Asset.

Responses

assets_asset_class_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_autocomplete_retrieve

Minimal endpoint for autocomplete selects — skips graph traversal.

Authorizations:
knoxApiToken

Responses

assets_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

assets_batch_create_create

Batch create multiple assets from a text list with parent-child relationships. Expected format: { "assets_text": "PR:Parent Asset\n SP:Child Asset 1\n SP:Child Asset 2", "folder": "folder-uuid" } Lines with leading spaces (2+) are children of the previous non-indented line.

Authorizations:
knoxApiToken

Responses

assets_disaster_recovery_objectives_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_dora_criticality_assessment_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_dora_discontinuing_impact_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_dora_licenced_activity_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_export_csv_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_export_xlsx_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_graph_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_ids_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_security_objectives_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses

assets_type_retrieve

API endpoint that allows assets to be viewed or edited.

Authorizations:
knoxApiToken

Responses