References#

Complete API Reference#

API v2 Calls Table#

Method

URL

Description

GET

/v2/alerts/:id/

POST

/v2/alerts/:id/disposition/:disposition

POST

/v2/alerts/

GET

/v2/alerts/disposition/

POST

/v2/alerts/disposition

GET

/v2/alerts

GET

/v2/configs/

POST

/v2/configs/

DELETE

/v2/configs/asset_groups/:instance_id/

GET

/v2/configs/asset_groups/:instance_id/

DELETE

/v2/configs/asset_groups/

GET

/v2/configs/asset_groups/

POST

/v2/configs/asset_groups/

PUT

/v2/configs/asset_groups/

DELETE

/v2/configs/assets/:instance_id/

GET

/v2/configs/assets/:instance_id/

DELETE

/v2/configs/assets/

GET

/v2/configs/assets/

POST

/v2/configs/assets/

PUT

/v2/configs/assets/

DELETE

/v2/configs/controls/:instance_id/

GET

/v2/configs/controls/:instance_id/

DELETE

/v2/configs/controls/

GET

/v2/configs/controls/

POST

/v2/configs/controls/

PUT

/v2/configs/controls/

DELETE

/v2/configs/credentials/:instance_id/

GET

/v2/configs/credentials/:instance_id/

DELETE

/v2/configs/credentials/

GET

/v2/configs/credentials/

POST

/v2/configs/credentials/

PUT

/v2/configs/credentials/

DELETE

/v2/configs/policy_filters/:instance_id/

GET

/v2/configs/policy_filters/:instance_id/

DELETE

/v2/configs/policy_filters/

GET

/v2/configs/policy_filters/

POST

/v2/configs/policy_filters/

PUT

/v2/configs/policy_filters/

DELETE

/v2/configs/policy_modules/:instance_id/

GET

/v2/configs/policy_modules/:instance_id/

DELETE

/v2/configs/policy_modules/

GET

/v2/configs/policy_modules/

POST

/v2/configs/policy_modules/

PUT

/v2/configs/policy_modules/

DELETE

/v2/configs/probe_groups/:instance_id/

GET

/v2/configs/probe_groups/:instance_id/

DELETE

/v2/configs/probe_groups/

GET

/v2/configs/probe_groups/

POST

/v2/configs/probe_groups/

PUT

/v2/configs/probe_groups/

DELETE

/v2/configs/probes/:instance_id/

GET

/v2/configs/probes/:instance_id/

DELETE

/v2/configs/probes/

GET

/v2/configs/probes/

POST

/v2/configs/probes/

PUT

/v2/configs/probes/

DELETE

/v2/configs/profile_filters/:instance_id/

GET

/v2/configs/profile_filters/:instance_id/

DELETE

/v2/configs/profile_filters/

GET

/v2/configs/profile_filters/

POST

/v2/configs/profile_filters/

PUT

/v2/configs/profile_filters/

DELETE

/v2/configs/profiles/:instance_id/

GET

/v2/configs/profiles/:instance_id/

DELETE

/v2/configs/profiles/

GET

/v2/configs/profiles/

POST

/v2/configs/profiles/

PUT

/v2/configs/profiles/

GET

/v2/configs/scripts/:instance_id/

GET

/v2/configs/scripts/

DELETE

/v2/cucm/drop/:cucmId/

POST

/v2/cucm/drop/:cucmId/

GET

/v2/cucm/drop/

POST

/v2/login

PUT

/v2/system/:key/:value

GET

/v2/system/:parameter/

GET

/v2/system/

PUT

/v2/system/

Status Codes#

All status codes are standard HTTP status codes. The table below are status codes commonly used in LayerX’s API.

Status Code

Description

200

OK

400

Bad Request by Client

403

Forbidden

404

Resource no found

500

Internal LayerX Error

501

Not Implemented

503

Service Unavailable

Disposition Description#

Value

Description

0

Open.

1

Under Review.

2

Acknowledged.

3

Release.

4

Disregarded. This will delete Alert from system.

14

Closed.

15

Closed and Locked. This will delete Alert from system.