IntelSource

Contents

• IntelSource

  • Summary

  • Create

  • Read Single

  • Read Multiple

  • Update

  • Delete

Summary

Resource	Operation	Description
IntelSource	POST /api/intel/source	Creates a new intel source.
	GET /api/intel/source/(int:intel_source_id)	Gets a single intel source given its ID.
	GET /api/intel/source	Gets a list of all the intel sources.
	PUT /api/intel/source/(int:intel_source_id)	Updates an existing intel source.
	DELETE /api/intel/source/(int:intel_source_id)	Deletes an intel source.

Create

JSON Schema

Required parameters are in bold.

type	object
properties
value	type	string
	maxLength	255
	minLength	1
additionalProperties	False

POST /api/intel/source

Creates a new intel source.

Example request:

POST /intel/source HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json

{
  "value": "OSINT"
}

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": 1,
  "value": "OSINT"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 201 Created – Intel source created

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 409 Conflict – Intel source already exists

Read Single

GET /api/intel/source/(int: intel_source_id)

Gets a single intel source given its ID.

Example request:

GET /intel/source/1 HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "value": "OSINT"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Intel source found

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Intel source ID not found

Read Multiple

GET /api/intel/source

Gets a list of all the intel sources.

Example request:

GET /intel/source HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": 1,
    "value": "OSINT"
  },
  {
    "id": 2,
    "value": "VirusTotal"
  }
]

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Intel sources found

• 401 Unauthorized – Invalid role to perform this action

Update

JSON Schema

Required parameters are in bold.

type	object
properties
value	type	string
	maxLength	255
	minLength	1
additionalProperties	False

PUT /api/intel/source/(int: intel_source_id)

Updates an existing intel source.

Example request:

PUT /intel/source/1 HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json

{
  "value": "VirusTotal",
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "value": "VirusTotal"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Intel source updated

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Intel source ID not found

• 409 Conflict – Intel source already exists

Delete

DELETE /api/intel/source/(int: intel_source_id)

Deletes an intel source.

Example request:

DELETE /intel/source/1 HTTP/1.1
Host: 127.0.0.1

Example response:

HTTP/1.1 204 No Content

Request Headers

• Authorization – Optional Apikey value

Status Codes

• 204 No Content – Intel source deleted

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Intel source ID not found

• 409 Conflict – Unable to delete intel source due to foreign key constraints