Centinus Developer API

Centinus API

Endpointhttps://gateway.centinus.com

Health check

GET

https://gateway.centinus.com

/health

Returns the health status of the API

Health check › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Health check › Responses

200

No data returned

GET/health

curl --request GET \
  --url https://gateway.centinus.com/health \
  --header 'Authorization: <string>'

shell

Example Responses

No example specified for this content type

Create a new incident

POST

https://gateway.centinus.com

/{orgId}/incident

Adds an incident to the incident queue for triaging within Centinus. Optionally, incidents can be elevated directly to the flight queue.

Create a new incident › query Parameters

elevate

boolean

Flag to elevate the incident directly into the Flight queue

externalId

string

Optional unique identifier provided by the external system

Create a new incident › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new incident › Request Body

object · required

displayName

string · required

Name to display

Example: Jane Brown

occurredAt

string · date-time · required

Timestamp of when the incident occurred

Example: 2024-10-15T14:30:00Z

urgent

boolean

true value marks the incident or elevated flight with a high priority

description

string

Text description of event and anything else to display to operator

Example: A suspicious activity reported in the area.

Image can be provided as a URL or a Base64-encoded string.

dispatcher

string

Identifier of dispatcher who initiated the drone dispatch

Example: dispatcher_123

Create a new incident › Responses

Successfully created incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

POST/{orgId}/incident

curl --request POST \
  --url https://gateway.centinus.com/:orgId/incident \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "urgent": true,
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "displayName": "Jane Brown",
  "description": "A suspicious activity reported in the area.",
  "image": "https://www.example.com/path/to/resource",
  "dispatcher": "dispatcher_123",
  "occurredAt": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "urgent": true,
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "displayName": "Jane Brown",
  "description": "A suspicious activity reported in the area.",
  "image": "https://www.example.com/path/to/resource",
  "dispatcher": "dispatcher_123",
  "occurredAt": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Update an existing incident by Centinus ID

PUT

https://gateway.centinus.com

/{orgId}/incident/{id}

Updates an incident identified by the Centinus ID. Currently limited to updating location.

Update an existing incident by Centinus ID › path Parameters

id

string · required

Centinus unique identifier for the incident

Update an existing incident by Centinus ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update an existing incident by Centinus ID › Request Body

object · required

updatedAt

string · date-time · required

Timestamp of the update

Example: 2024-10-16T10:15:00Z

Update an existing incident by Centinus ID › Responses

Successfully updated incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

PUT/{orgId}/incident/{id}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/incident/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "updatedAt": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Delete an incident from the queue

DELETE

https://gateway.centinus.com

/{orgId}/incident/{id}

Delete an incident from the queue › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete an incident from the queue › Responses

Successfully deleted incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

DELETE/{orgId}/incident/{id}

curl --request DELETE \
  --url https://gateway.centinus.com/:orgId/incident/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Update an existing incident by External ID

PUT

https://gateway.centinus.com

/{orgId}/incident/externalId/{externalId}

Updates an incident identified by the external ID. Currently limited to updating location.

Update an existing incident by External ID › path Parameters

externalId

string · required

External system's unique identifier for the incident

orgId

string · required

Organization ID for scoping

Update an existing incident by External ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update an existing incident by External ID › Request Body

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

Update an existing incident by External ID › Responses

Successfully updated incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

PUT/{orgId}/incident/externalId/{externalId}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/incident/externalId/:externalId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "incident_456",
  "externalId": "ext_789"
}
'

shell

Example Request Body

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Delete an incident from the queue

DELETE

https://gateway.centinus.com

/{orgId}/incident/externalId/{externalId}

Delete an incident from the queue › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete an incident from the queue › Responses

Successfully deleted incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

DELETE/{orgId}/incident/externalId/{externalId}

curl --request DELETE \
  --url https://gateway.centinus.com/:orgId/incident/externalId/:externalId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Webhook: Flight creation event

POST

https://gateway.centinus.com

/{orgId}/event/flight

Webhook for new flight alert

Webhook: Flight creation event › path Parameters

orgId

string · required

Organization ID for scoping

Webhook: Flight creation event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Webhook: Flight creation event › Request Body

flightId

string · required

Unique identifier for the flight

Example: flight_001

createdAt

string · date-time · required

Timestamp when the flight was created

Example: 2024-10-15T14:30:00Z

status

string · required

Current status of the flight

Example: initialized

eventTime

string · date-time · required

Timestamp of the event

Example: 2024-10-15T14:35:00Z

object · required

object

Webhook: Flight creation event › Responses

200

No data returned

POST/{orgId}/event/flight

curl --request POST \
  --url https://gateway.centinus.com/:orgId/event/flight \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flightId": "flight_001",
  "createdAt": "2024-08-25T15:00:00Z",
  "status": "initialized",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "drone": {
    "type": "DJI Phantom 4",
    "serialNo": "SN123456789",
    "name": "Alpha"
  },
  "pilot": {
    "userId": "pilot_001",
    "name": "John Doe",
    "profile": {
      "experience": "5 years",
      "certifications": [
        "FAA Part 107"
      ]
    }
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}
'

shell

Example Request Body

{
  "flightId": "flight_001",
  "createdAt": "2024-08-25T15:00:00Z",
  "status": "initialized",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "drone": {
    "type": "DJI Phantom 4",
    "serialNo": "SN123456789",
    "name": "Alpha"
  },
  "pilot": {
    "userId": "pilot_001",
    "name": "John Doe",
    "profile": {
      "experience": "5 years",
      "certifications": [
        "FAA Part 107"
      ]
    }
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Flight update event

PUT

https://gateway.centinus.com

/{orgId}/event/flight/{flightId}

Webhook flight update

Webhook: Flight update event › path Parameters

orgId

string · required

Organization ID for scoping

id

string · required

Centinus unique identifier for the flight

Webhook: Flight update event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Webhook: Flight update event › Request Body

flightId

string · required

Unique identifier for the flight

Example: flight_001

status

string · required

Updated status of the flight

Example: in_progress

eventTime

string · date-time · required

Timestamp of the update event

Example: 2024-10-15T15:00:00Z

object · required

object

Webhook: Flight update event › Responses

200

No data returned

PUT/{orgId}/event/flight/{flightId}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/event/flight/:flightId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flightId": "flight_001",
  "status": "in_progress",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}
'

shell

Example Request Body

{
  "flightId": "flight_001",
  "status": "in_progress",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Media creation event

POST

https://gateway.centinus.com

/{orgId}/event/media

Webhook: Media creation event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST/{orgId}/event/media

curl --request POST \
  --url https://gateway.centinus.com/:orgId/event/media \
  --header 'Authorization: <string>'

shell

Example Responses

No example specified for this content type

Centinus API

Endpointhttps://gateway.centinus.com

Health check

GET

https://gateway.centinus.com

/health

Returns the health status of the API

Health check › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Health check › Responses

200

No data returned

GET/health

curl --request GET \
  --url https://gateway.centinus.com/health \
  --header 'Authorization: <string>'

shell

Example Responses

No example specified for this content type

Create a new incident

POST

https://gateway.centinus.com

/{orgId}/incident

Adds an incident to the incident queue for triaging within Centinus. Optionally, incidents can be elevated directly to the flight queue.

Create a new incident › query Parameters

elevate

boolean

Flag to elevate the incident directly into the Flight queue

externalId

string

Optional unique identifier provided by the external system

Create a new incident › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new incident › Request Body

object · required

displayName

string · required

Name to display

Example: Jane Brown

occurredAt

string · date-time · required

Timestamp of when the incident occurred

Example: 2024-10-15T14:30:00Z

urgent

boolean

true value marks the incident or elevated flight with a high priority

description

string

Text description of event and anything else to display to operator

Example: A suspicious activity reported in the area.

Image can be provided as a URL or a Base64-encoded string.

dispatcher

string

Identifier of dispatcher who initiated the drone dispatch

Example: dispatcher_123

Create a new incident › Responses

Successfully created incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

POST/{orgId}/incident

curl --request POST \
  --url https://gateway.centinus.com/:orgId/incident \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "urgent": true,
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "displayName": "Jane Brown",
  "description": "A suspicious activity reported in the area.",
  "image": "https://www.example.com/path/to/resource",
  "dispatcher": "dispatcher_123",
  "occurredAt": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "urgent": true,
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "displayName": "Jane Brown",
  "description": "A suspicious activity reported in the area.",
  "image": "https://www.example.com/path/to/resource",
  "dispatcher": "dispatcher_123",
  "occurredAt": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Update an existing incident by Centinus ID

PUT

https://gateway.centinus.com

/{orgId}/incident/{id}

Updates an incident identified by the Centinus ID. Currently limited to updating location.

Update an existing incident by Centinus ID › path Parameters

id

string · required

Centinus unique identifier for the incident

Update an existing incident by Centinus ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update an existing incident by Centinus ID › Request Body

object · required

updatedAt

string · date-time · required

Timestamp of the update

Example: 2024-10-16T10:15:00Z

Update an existing incident by Centinus ID › Responses

Successfully updated incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

PUT/{orgId}/incident/{id}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/incident/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "updatedAt": "2024-08-25T15:00:00Z"
}
'

shell

Example Request Body

{
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Delete an incident from the queue

DELETE

https://gateway.centinus.com

/{orgId}/incident/{id}

Delete an incident from the queue › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete an incident from the queue › Responses

Successfully deleted incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

DELETE/{orgId}/incident/{id}

curl --request DELETE \
  --url https://gateway.centinus.com/:orgId/incident/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Update an existing incident by External ID

PUT

https://gateway.centinus.com

/{orgId}/incident/externalId/{externalId}

Updates an incident identified by the external ID. Currently limited to updating location.

Update an existing incident by External ID › path Parameters

externalId

string · required

External system's unique identifier for the incident

orgId

string · required

Organization ID for scoping

Update an existing incident by External ID › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update an existing incident by External ID › Request Body

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

Update an existing incident by External ID › Responses

Successfully updated incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

PUT/{orgId}/incident/externalId/{externalId}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/incident/externalId/:externalId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "incident_456",
  "externalId": "ext_789"
}
'

shell

Example Request Body

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Delete an incident from the queue

DELETE

https://gateway.centinus.com

/{orgId}/incident/externalId/{externalId}

Delete an incident from the queue › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Delete an incident from the queue › Responses

Successfully deleted incident

id

string

Centinus unique identifier

Example: incident_456

externalId

string

External system's unique identifier

Example: ext_789

DELETE/{orgId}/incident/externalId/{externalId}

curl --request DELETE \
  --url https://gateway.centinus.com/:orgId/incident/externalId/:externalId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "incident_456",
  "externalId": "ext_789"
}

json

application/json

Webhook: Flight creation event

POST

https://gateway.centinus.com

/{orgId}/event/flight

Webhook for new flight alert

Webhook: Flight creation event › path Parameters

orgId

string · required

Organization ID for scoping

Webhook: Flight creation event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Webhook: Flight creation event › Request Body

flightId

string · required

Unique identifier for the flight

Example: flight_001

createdAt

string · date-time · required

Timestamp when the flight was created

Example: 2024-10-15T14:30:00Z

status

string · required

Current status of the flight

Example: initialized

eventTime

string · date-time · required

Timestamp of the event

Example: 2024-10-15T14:35:00Z

object · required

object

Webhook: Flight creation event › Responses

200

No data returned

POST/{orgId}/event/flight

curl --request POST \
  --url https://gateway.centinus.com/:orgId/event/flight \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flightId": "flight_001",
  "createdAt": "2024-08-25T15:00:00Z",
  "status": "initialized",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "drone": {
    "type": "DJI Phantom 4",
    "serialNo": "SN123456789",
    "name": "Alpha"
  },
  "pilot": {
    "userId": "pilot_001",
    "name": "John Doe",
    "profile": {
      "experience": "5 years",
      "certifications": [
        "FAA Part 107"
      ]
    }
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}
'

shell

Example Request Body

{
  "flightId": "flight_001",
  "createdAt": "2024-08-25T15:00:00Z",
  "status": "initialized",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "drone": {
    "type": "DJI Phantom 4",
    "serialNo": "SN123456789",
    "name": "Alpha"
  },
  "pilot": {
    "userId": "pilot_001",
    "name": "John Doe",
    "profile": {
      "experience": "5 years",
      "certifications": [
        "FAA Part 107"
      ]
    }
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Flight update event

PUT

https://gateway.centinus.com

/{orgId}/event/flight/{flightId}

Webhook flight update

Webhook: Flight update event › path Parameters

orgId

string · required

Organization ID for scoping

id

string · required

Centinus unique identifier for the flight

Webhook: Flight update event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Webhook: Flight update event › Request Body

flightId

string · required

Unique identifier for the flight

Example: flight_001

status

string · required

Updated status of the flight

Example: in_progress

eventTime

string · date-time · required

Timestamp of the update event

Example: 2024-10-15T15:00:00Z

object · required

object

Webhook: Flight update event › Responses

200

No data returned

PUT/{orgId}/event/flight/{flightId}

curl --request PUT \
  --url https://gateway.centinus.com/:orgId/event/flight/:flightId \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flightId": "flight_001",
  "status": "in_progress",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}
'

shell

Example Request Body

{
  "flightId": "flight_001",
  "status": "in_progress",
  "eventTime": "2024-08-25T15:00:00Z",
  "location": {
    "lat": 37.7749,
    "lon": -122.4194
  },
  "incident": {
    "id": "incident_456",
    "externalId": "ext_789"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Media creation event

POST

https://gateway.centinus.com

/{orgId}/event/media

Webhook: Media creation event › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

POST/{orgId}/event/media

curl --request POST \
  --url https://gateway.centinus.com/:orgId/event/media \
  --header 'Authorization: <string>'

shell

Example Responses

No example specified for this content type