For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Accountinfo

get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
descriptionstringOptional
formatstring · enumOptionalPossible values:
limitintegerOptional

Number of results to return per page.

namestringOptional
offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

A search term.

Responses
200Success
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100
get/accountinfo/config/
GET /accountinfo/config/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "datatype": "TEXT",
      "datatarget": "ASSET",
      "accountinfo_values": [
        1
      ]
    }
  ]
}
post

Handle post request, suitable for single and multi creation

Args: request ([dict]): can be dict or list of dicts

Returns: [type]: [description]

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
Responses
201Success

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
post/accountinfo/config/
POST /accountinfo/config/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"name='text'&description='text'&datatype='TEXT'&datatarget='ASSET'"
201Success
{
  "id": 1,
  "name": "text",
  "description": "text",
  "datatype": "TEXT",
  "datatarget": "ASSET",
  "accountinfo_values": [
    1
  ]
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo config.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
get/accountinfo/config/{id}/
GET /accountinfo/config/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "name": "text",
  "description": "text",
  "datatype": "TEXT",
  "datatarget": "ASSET",
  "accountinfo_values": [
    1
  ]
}
put

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo config.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
put/accountinfo/config/{id}/
PUT /accountinfo/config/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"name='text'&description='text'&datatype='TEXT'&datatarget='ASSET'"
200Success
{
  "id": 1,
  "name": "text",
  "description": "text",
  "datatype": "TEXT",
  "datatarget": "ASSET",
  "accountinfo_values": [
    1
  ]
}
delete

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo config.

Query parameters
formatstring · enumOptionalPossible values:
Responses
204

No response body

No content

delete/accountinfo/config/{id}/
DELETE /accountinfo/config/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

patch

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo config.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyOptional
namestring · max: 100Optional
descriptionstring · max: 512Optional
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyOptional
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
namestring · max: 100Required
descriptionstring · max: 512Required
datatypestring · enumOptional
  • TEXT - Text
  • TEXTAREA - Textarea
  • SELECT - Select
  • CHECKBOX - Checkbox
Possible values:
datatargetstring · enumOptional
  • ASSET - Assets
  • IPDISCOVER - IPDiscover
Possible values:
accountinfo_valuesinteger[]Read-onlyRequired
patch/accountinfo/config/{id}/
PATCH /accountinfo/config/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 75

"name='text'&description='text'&datatype='TEXT'&datatarget='ASSET'"
200Success
{
  "id": 1,
  "name": "text",
  "description": "text",
  "datatype": "TEXT",
  "datatarget": "ASSET",
  "accountinfo_values": [
    1
  ]
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
limitintegerOptional

Number of results to return per page.

object_idintegerOptional
object_slugstringOptional
offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

A search term.

Responses
200Success
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100
get/accountinfo/data/
GET /accountinfo/data/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 1,
      "accountdata": null,
      "object_slug": "text",
      "content_type": 1,
      "object_id": 1
    }
  ]
}
post

Handle post request, suitable for single and multi creation

Args: request ([dict]): can be dict or list of dicts

Returns: [type]: [description]

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
Responses
201Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
post/accountinfo/data/
POST /accountinfo/data/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"accountdata=null&object_slug='text'&object_id=1"
201Success
{
  "id": 1,
  "accountdata": null,
  "object_slug": "text",
  "content_type": 1,
  "object_id": 1
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo data.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
get/accountinfo/data/{id}/
GET /accountinfo/data/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "accountdata": null,
  "object_slug": "text",
  "content_type": 1,
  "object_id": 1
}
put

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo data.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
put/accountinfo/data/{id}/
PUT /accountinfo/data/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"accountdata=null&object_slug='text'&object_id=1"
200Success
{
  "id": 1,
  "accountdata": null,
  "object_slug": "text",
  "content_type": 1,
  "object_id": 1
}
delete

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo data.

Query parameters
formatstring · enumOptionalPossible values:
Responses
204

No response body

No content

delete/accountinfo/data/{id}/
DELETE /accountinfo/data/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

patch

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo data.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyOptional
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyOptional
object_idinteger · int64 · max: 9223372036854776000Optional
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountdataany · nullableOptional
object_slugstring · max: 100 · nullableOptional
content_typeintegerRead-onlyRequired
object_idinteger · int64 · max: 9223372036854776000Required
patch/accountinfo/data/{id}/
PATCH /accountinfo/data/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 55

"accountdata=null&object_slug='text'&object_id=1"
200Success
{
  "id": 1,
  "accountdata": null,
  "object_slug": "text",
  "content_type": 1,
  "object_id": 1
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
accountinfo_configintegerOptional
formatstring · enumOptionalPossible values:
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingstringOptional

Which field to use when ordering the results.

searchstringOptional

A search term.

valuestringOptional
Responses
200Success
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100
get/accountinfo/value/
GET /accountinfo/value/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 1,
      "accountinfo_config": 1,
      "value": "text"
    }
  ]
}
post

Handle post request, suitable for single and multi creation

Args: request ([dict]): can be dict or list of dicts

Returns: [type]: [description]

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
Responses
201Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
post/accountinfo/value/
POST /accountinfo/value/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39

"accountinfo_config=1&value='text'"
201Success
{
  "id": 1,
  "accountinfo_config": 1,
  "value": "text"
}
get

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo value.

Query parameters
formatstring · enumOptionalPossible values:
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
get/accountinfo/value/{id}/
GET /accountinfo/value/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "accountinfo_config": 1,
  "value": "text"
}
put

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo value.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
put/accountinfo/value/{id}/
PUT /accountinfo/value/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39

"accountinfo_config=1&value='text'"
200Success
{
  "id": 1,
  "accountinfo_config": 1,
  "value": "text"
}
delete

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo value.

Query parameters
formatstring · enumOptionalPossible values:
Responses
204

No response body

No content

delete/accountinfo/value/{id}/
DELETE /accountinfo/value/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

patch

This class will define the view behavior

Args: viewsets ([OCSVIewSet])

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idintegerRequired

A unique integer value identifying this accountinfo value.

Query parameters
formatstring · enumOptionalPossible values:
Body

This serialize class provide the API representation

idintegerRead-onlyOptional
accountinfo_configintegerOptional
valuestring · max: 100Optional
Responses
200Success

This serialize class provide the API representation

idintegerRead-onlyRequired
accountinfo_configintegerRequired
valuestring · max: 100Required
patch/accountinfo/value/{id}/
PATCH /accountinfo/value/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39

"accountinfo_config=1&value='text'"
200Success
{
  "id": 1,
  "accountinfo_config": 1,
  "value": "text"
}

Last updated