Skip to content

Report App Management API

Jim Lake edited this page Apr 26, 2015 · 1 revision

These endpoints all the management of applications and API keys used by the data ingest endpoints.

API Endpoint

All calls are made on the standard report endpoint:

https://report.data-cortex.com

List Apps

List all application for this organization.

GET /api/1/app

Request Arguments

org_id - string - Organization ID

Responses

200 OK

app_list - list of objects - List of applications

  • app_id - number - Application ID

  • name - string - Application name

  • api_key_list - list of string - List of API keys for this application

403 Forbidden

Not allowed to list that organizations applications.

Create App

Create a new application.

GET /api/1/app

Request Arguments

org_id - string - Organization ID

app_name - string - Application Name

Responses

200 OK

app_id - number - Application ID

403 Forbidden

Not allowed to add an application that organization.

Delete App

Delete application. Beward, this will remove any API keys associated with applications that are deleted. If clients are still in the wild sending events with those API keys, future requests will be dropped.

DELETE /api/1/app/:app_id

Request Arguments

app_id - string - Application ID

Responses

200 OK

Application deleted.

403 Forbidden

Not allowed to delete that application.

Clone this wiki locally