Staged Configuration Endpoints
Use the references for REST API V7.0 staged configuration endpoints.
GET /staged_config/deploy_status
Retrieves the status of a deploy in progress.
Table 1: GET /staged_config/deploy_status Resource Details
MIME Type |
|---|
application/json |
There are no parameters for this endpoint.
Table 2: GET /staged_config/deploy_status Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The event Ariel saved search group was updated. | |
500 | 1020 | An error occurred during the attempt to retrieve the status of the running deploy, |
Response Description
The deploy status object. A deploy status object contains the following fields:
initiated_by - String - The name of the user who initiated the deploy.
initiated_from - String - The hostname from where the deploy was initiated.
type - String - The type of deploy: FULL or INCREMENTAL.
status - String - The status of the deploy: UNKNOWN, START, DONE.
hosts - Map of < String, List of String > - A map of status states and a list of hosts.
error_message - String - The deployment error message.
has_errors - Boolean - True if the deploy has encountered an error.
percent_complete - Integer - The percentage of completion of the deploy. ( 0 - 100 )
Response Sample
{ "hosts": [ { "host_status": "String
<one of: SUCCESS, INITIATING,
IN_PROGRESS,
TIMED_OUT, ERROR>",
"ip": "String", "status": "String <one of: SUCCESS,
INITIATING,
IN_PROGRESS,
TIMED_OUT, ERROR>" } ], "initiated_by":
"String", "initiated_from": "String", "percent_complete":
42, "status": "String <one of: INITIALIZING,
IN_PROGRESS, COMPLETE>",
"type": "String <one of: INCREMENTAL, FULL>" }POST /staged_config/deploy_status
Executes a deploy.
Table 3: POST /staged_config/deploy_status Resource Details
MIME Type |
|---|
application/json |
Table 4: POST /staged_config/deploy_status Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
deploy_status | Object | application/json | null | { "hosts": [ { "host_status": "String <one of: SUCCESS, INITIATING, IN_PROGRESS, TIMED_OUT, ERROR>", "ip": "String", "status": "String <one of: SUCCESS, INITIATING, IN_PROGRESS, TIMED_OUT, ERROR>" } ], "initiated_by": "String", "initiated_from": "String", "percent_complete": 42, "status": "String <one of: INITIALIZING, IN_PROGRESS, COMPLETE>", "type": "String <one of: INCREMENTAL, FULL>" } |
Table 5: POST /staged_config/deploy_status Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The deploy was scheduled. | |
409 | 1002 | Theere already exists a deploy in action, or there are no changes to deploy. |
409 | 1003 | null |
409 | 1004 | null |
422 | 1005 | null |
500 | 1020 | An error occurred during the attempt to run the deploy |
Response Description
The deploy status object. A deploy status object contains the following fields:
initiated_by - String - The name of the user who initiated the deploy.
initiated_from - String - The hostname from where the deploy was initiated.
type - String - The type of deploy: FULL or INCREMENTAL.
status - String - The status of the deploy: UNKNOWN, START, DONE.
hosts - Map of < String, List of String > - A map of status states and a list of hosts.
error_message - String - The deployment error message.
has_errors - Boolean - True if the deploy has encountered an error.
percent_complete - Integer - The percentage of completion of the deploy. ( 0 - 100 )
Response Sample
{ "hosts": [ { "host_status": "String
<one of: SUCCESS, INITIATING,
IN_PROGRESS,
TIMED_OUT, ERROR>",
"ip": "String", "status": "String <one of: SUCCESS,
INITIATING,
IN_PROGRESS,
TIMED_OUT, ERROR>" } ], "initiated_by":
"String", "initiated_from": "String", "percent_complete":
42, "status": "String <one of: INITIALIZING,
IN_PROGRESS, COMPLETE>",
"type": "String <one of: INCREMENTAL, FULL>" }GET /staged_config/deployment/hosts
Retrieves a list of all staged hosts.
Table 6: GET /staged_config/deployment/hosts Resource Details
MIME Type |
|---|
application/json |
Table 7: GET /staged_config/deployment/hosts Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Table 8: GET /staged_config/deployment/hosts Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The host list was successfully retrieved. | |
500 | 1005 | An error occurred during the attempt to retrieve the host list. |
Response Description
A list of all the hosts. Each Host object has the following fields:
id - The ID of this managed host.
hostname - The host name of this managed host.
private_ip - The private IP of this managed host.
public_ip - The public IP of this managed host.
appliance - An object that represents the appliance type ID and description of this managed host.
version - The installed version on this managed host.
status - The status of this managed host.
eps_rate_hardware_limit - The upper limit for eps_allocation based on hardware constraints for this managed host.
eps_allocation - The allocated eps rate of this managed host.
average_eps - The average eps rate of this managed host over the previous month.
peak_eps - The peak eps rate that was experienced by this managed host over the previous month.
fpm_rate_hardware_limit - The upper limit for fpm_allocation based on hardware constraints for this managed host.
fpm_allocation - The allocated fpm rate of this managed host.
average_fpm - The average fpm rate of this managed host over the previous month.
peak_fpm - The peak fpm rate that was experienced by this managed host over the previous month.
primary_server_id - The ID for the primary server host for this managed host.
secondary_server_id - If configured, the ID for the secondary server host for this managed host.
license_serial_number - The serial number that is associated with this managed host's license.
components - A list of components that are associated with this managed host.
compression_enabled - Whether or not compression is enabled for this managed host.
encryption_enabled - Whether or not encryption is enabled for this managed host.
Response Sample
[ { "appliance": { "id": "String",
"type": "String" }, "average_eps": 42,
"average_fpm": 42, "components": [ "String
<one of: eventcollector, eventprocessor,
dataNode,
magistrate, ariel_query_server,
ariel_proxy_server,
vis, assetprofiler,
qflow, hostcontext,
tunnel,
setuptunnel, ecs-ec,
ecs-ep, resolveragent,
resolver_manager,
offsiteSource, offsiteTarget,
accumulator,
offline_forwarder, qvm,
qvmprocessor, qvmscanner,
qvmhostedscanner,
qvmsiteprotector, arc_builder,
tomcat-rm,
ziptie-server, qrm,
asset_change_publisher,
forensicsnode, forensics_realtime,
masterdaemon>" ], "compression_enabled":
true, "encryption_enabled": true, "eps_allocation":
42, "eps_rate_hardware_limit": 42, "fpm_allocation":
42, "fpm_rate_hardware_limit": 42, "hostname": "String",
"id": 42, "license_serial_number": "String",
"peak_eps": 42, "peak_fpm": 42, "primary_server_id":
42, "private_ip": "String", "public_ip": "String",
"secondary_server_id": 42, "status": "String <one
of: Active, ADDING,
Deleted, Deleting,
ADD_FAILED,
New, ADD_FAILED_VERSION_CHECK,
ADD_FAILED_DEPLOY_IN_PROGRESS,
ADD_FAILED_RETRY_CONNECTION,
ADD_FAILED_HA,
ADD_FAILED_CHECK_LOGS>", "version": "String"
} ]GET /staged_config/deployment/hosts/{id}
Retrieves a staged host by ID.
Table 9: GET /staged_config/deployment/hosts/{id} Resource Details
MIME Type |
|---|
application/json |
Table 10: GET /staged_config/deployment/hosts/{id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
id | path | Required | Number (Integer) | text/plain | Required - The ID of the staged host to be retrieved. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 11: GET /staged_config/deployment/hosts/{id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The host was successfully retrieved. | |
404 | 1006 | No such staged host for the given ID |
422 | 1007 | The provided ID was a negative number or zero. |
500 | 1008 | An error occurred during the retrieval of the host. |
Response Description
The associated staged host object. The Host object has the following fields:
id - The ID of this managed host.
hostname - The host name of this managed host.
private_ip - The private IP of this managed host.
public_ip - The public IP of this managed host.
appliance - An object that represents the appliance type ID and description of this managed host.
version - The installed version on this managed host.
status - The status of this managed host.
eps_rate_hardware_limit - The upper limit for eps_allocation based on hardware constraints for this managed host.
eps_allocation - The allocated eps rate of this managed host.
average_eps - The average eps rate of this managed host over the previous month.
peak_eps - The peak eps rate that was experienced by this managed host over the previous month.
fpm_rate_hardware_limit - The upper limit for fpm_allocation based on hardware constraints for this managed host.
fpm_allocation - The allocated fpm rate of this managed host.
average_fpm - The average fpm rate of this managed host over the previous month.
peak_fpm - The peak fpm rate that was experienced by this managed host over the previous month.
primary_server_id - The ID for the primary server host for this managed host.
secondary_server_id - If configured, the ID for the secondary server host for this managed host.
license_serial_number - The serial number that is associated with this managed host's license.
components - A list of components that are associated with this managed host.
compression_enabled - Whether or not compression is enabled for this managed host.
encryption_enabled - Whether or not encryption is enabled for this managed host.
Response Sample
{ "appliance": { "id": "String", "type":
"String" }, "average_eps": 42, "average_fpm": 42,
"components": [ "String <one of: eventcollector,
eventprocessor,
dataNode, magistrate,
ariel_query_server,
ariel_proxy_server, vis,
assetprofiler, qflow,
hostcontext,
tunnel, setuptunnel,
ecs-ec, ecs-ep,
resolveragent,
resolver_manager, offsiteSource,
offsiteTarget,
accumulator, offline_forwarder,
qvm, qvmprocessor,
qvmscanner,
qvmhostedscanner, qvmsiteprotector,
arc_builder,
tomcat-rm, ziptie-server,
qrm, asset_change_publisher,
forensicsnode,
forensics_realtime, masterdaemon>"
], "compression_enabled": true, "encryption_enabled":
true, "eps_allocation": 42, "eps_rate_hardware_limit": 42,
"fpm_allocation": 42, "fpm_rate_hardware_limit": 42, "hostname":
"String", "id": 42, "license_serial_number": "String",
"peak_eps": 42, "peak_fpm": 42, "primary_server_id": 42,
"private_ip": "String", "public_ip": "String", "secondary_server_id":
42, "status": "String <one of: Active,
ADDING, Deleted,
Deleting, ADD_FAILED,
New,
ADD_FAILED_VERSION_CHECK, ADD_FAILED_DEPLOY_IN_PROGRESS,
ADD_FAILED_RETRY_CONNECTION,
ADD_FAILED_HA,
ADD_FAILED_CHECK_LOGS>", "version": "String" }GET /staged_config/global_system_notifications
Retrieves a list of all staged global system notifications.
Table 12: GET /staged_config/global_system_notifications Resource Details
MIME Type |
|---|
application/json |
Table 13: GET /staged_config/global_system_notifications Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 14: GET /staged_config/global_system_notifications Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged global system notifications list was successfully retrieved. | |
500 | 1020 | An internal server error occurred during retrieval of the list of staged global system notifications. |
Response Description
A list of all staged global system notifications. A notification contains the following fields:
id - Long - The ID of the notification.
name - String - The name of the notification.
operator - String - The notification criteria operator.
value - String - The notification criteria value.
message - Double - The notification message.
default - Boolean - Whether the notification message is modified by the user or not.
enabled - Boolean - Whether the notification is enabled or not.
Response Sample
[ { "default": true, "enabled": true,
"id": 42, "message": "String", "name": "String",
"operator": "String", "value": 42.5 } ]GET /staged_config/global_system_notifications/{notification_id}
Retrieves a staged global system notification by ID.
Table 15: GET /staged_config/global_system_notifications/{notification_id} Resource Details
MIME Type |
|---|
application/json |
Table 16: GET /staged_config/global_system_notifications/{notification_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
notification_id | path | Required | Number (Integer) | text/plain | ID that is used for retrieving a staged global system notification. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 17: GET /staged_config/global_system_notifications/{notification_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged global system notification was successfully retrieved. | |
404 | 1002 | No staged global system notification was found for the provided notification ID. |
500 | 1020 | An error occurred during the retrieval of the notification. |
Response Description
The associated staged global system notification object. A notification contains the following fields:
id - Long - The ID of the notification.
name - String - The name of the notification.
operator - String - The notification criteria operator.
value - String - The notification criteria value.
message - Double - The notification message.
default - Boolean - Whether the notification message is modified by the user or not.
enabled - Boolean - Whether the notification is enabled or not.
Response Sample
{ "default": true, "enabled": true, "id": 42,
"message": "String", "name": "String", "operator": "String",
"value": 42.5 }POST /staged_config/global_system_notifications/{notification_id}
Updates an existing staged global system notification.
Table 18: POST /staged_config/global_system_notifications/{notification_id} Resource Details
MIME Type |
|---|
application/json |
Table 19: POST /staged_config/global_system_notifications/{notification_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
notification_id | path | Required | Number (Integer) | text/plain | ID that is used for updating a staged global system notification. |
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Table 20: POST /staged_config/global_system_notifications/{notification_id} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
notification | Object | application/json | The updated global system notification object. | { "id": 1, "name": "Systemloadover1minute", "operator": "GT", "value": 3.6, "message": "If your system continues to exhibit this behavior, please contact Juniper Customer Support.", "enabled": true, "isDefault": true } |
Table 21: POST /staged_config/global_system_notifications/{notification_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged global system notification was successfully updated. | |
404 | 1002 | No staged global system notification was found for the provided notification ID. |
422 | 1005 | A request parameter is invalid. |
500 | 1020 | An error occurred during the retrieval of the notification. |
Response Description
The associated updated staged global system notification object. A notification contains the following fields:
id - Long - The ID of the notification.
name - String - The name of the notification.
operator - String - The notification criteria operator.
value - String - The notification criteria value.
message - Double - The notification message.
default - Boolean - Whether the notification message is modified by the user or not.
enabled - Boolean - Whether the notification is enabled or not.
Response Sample
{ "default": true, "enabled": true, "id": 42,
"message": "String", "name": "String", "operator": "String",
"value": 42.5 }GET /staged_config/remote_networks
Retrieves a list of staged remote networks.
Table 22: GET /staged_config/remote_networks Resource Details
MIME Type |
|---|
application/json |
Table 23: GET /staged_config/remote_networks Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
Table 24: GET /staged_config/remote_networks Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote networks list was successfully retrieved. | |
500 | 1020 | An internal server error occurred during the retrieval of the list of staged remote networks. |
Response Description
A list of staged remote networks.
id - Long - The ID of the remote network.
name - String - The name of the remote network.
description - String - The description of the remote network.
group - String - The group to which the remote network belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote network.
Response Sample
[ { "cidrs": [ "String" ],
"description": "String", "group": "String",
"id": 42, "name": "String" } ]POST /staged_config/remote_networks
Adds a new staged remote network.
Table 25: POST /staged_config/remote_networks Resource Details
MIME Type |
|---|
application/json |
Table 26: POST /staged_config/remote_networks Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 27: POST /staged_config/remote_networks Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
network | Object | application/json | The new remote network object. | { "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
Table 28: POST /staged_config/remote_networks Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
201 | The new staged remote network was successfully created. | |
409 | 1008 | The remote network name already exists in the selected group. |
422 | 1005 | A request parameter is invalid. |
500 | 1020 | An error occurred during the creation of the remote network. |
Response Description
The associated new created staged remote network object.
id - Long - The ID of the remote network.
name - String - The name of the remote network.
description - String - The description of the remote network.
group - String - The group to which the remote network belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote network.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}GET /staged_config/remote_networks/{network_id}
Retrieves a staged remote network by ID.
Table 29: GET /staged_config/remote_networks/{network_id} Resource Details
MIME Type |
|---|
application/json |
Table 30: GET /staged_config/remote_networks/{network_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
network_id | path | Required | Number (Integer) | text/plain | ID that is used to retrieve a staged remote network. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 31: GET /staged_config/remote_networks/{network_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote network was successfully retrieved. | |
404 | 1002 | No staged remote network was found with the provided ID. |
500 | 1020 | An error occurred during the retrieval of the remote network. |
Response Description
The associated staged remote network object.
id - Long - The ID of the remote network.
name - String - The name of the remote network.
description - String - The description of the remote network.
group - String - The group to which the remote network belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote network.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}POST /staged_config/remote_networks/{network_id}
Updates an existing staged remote network.
Table 32: POST /staged_config/remote_networks/{network_id} Resource Details
MIME Type |
|---|
application/json |
Table 33: POST /staged_config/remote_networks/{network_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
network_id | path | Required | Number (Integer) | text/plain | ID that is used to update a staged remote network. |
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 34: POST /staged_config/remote_networks/{network_id} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
network | Object | application/json | The updated remote network object. | { "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
Table 35: POST /staged_config/remote_networks/{network_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote network was successfully updated. | |
404 | 1002 | No staged remote network was found for the provided network ID. |
409 | 1008 | The remote network name already exists in the selected group. |
422 | 1005 | A request parameter is invalid. |
500 | 1020 | An error occurred during the update of the remote network. |
Response Description
The associated updated staged remote network object.
id - Long - The ID of the remote network.
name - String - The name of the remote network.
description - String - The description of the remote network.
group - String - The group to which the remote network belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote network.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}DELETE /staged_config/remote_networks/{network_id}
Deletes an existing staged remote network.
Table 36: DELETE /staged_config/remote_networks/{network_id} Resource Details
MIME Type |
|---|
text/plain |
Table 37: DELETE /staged_config/remote_networks/{network_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
network_id | path | Required | Number (Integer) | text/plain | ID that is used to locate the staged remote network. |
Table 38: DELETE /staged_config/remote_networks/{network_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
204 | The staged remote network was successfully deleted. | |
404 | 1002 | No staged remote network was found for the provided network ID. |
500 | 1020 | An error occurred during the deletion of the remote network. |
Response Description
Response Sample
GET /staged_config/remote_services
Retrieves a list of staged remote services.
Table 39: GET /staged_config/remote_services Resource Details
MIME Type |
|---|
application/json |
Table 40: GET /staged_config/remote_services Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
filter | query | Optional | String | text/plain | Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range | header | Optional | String | text/plain | Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
Table 41: GET /staged_config/remote_services Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote services list was successfully retrieved. | |
500 | 1020 | An internal server error occurred during the retrieval of the list of staged remote services. |
Response Description
A list of staged remote services.
id - Long - The ID of the remote service.
name - String - The name of the remote service.
description - String - The description of the remote service.
group - String - The group to which the remote service belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote service.
Response Sample
[ { "cidrs": [ "String" ],
"description": "String", "group": "String",
"id": 42, "name": "String" } ]POST /staged_config/remote_services
Adds a staged remote service.
Table 42: POST /staged_config/remote_services Resource Details
MIME Type |
|---|
application/json |
Table 43: POST /staged_config/remote_services Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 44: POST /staged_config/remote_services Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
service | Object | application/json | The new remote service object. | { "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
Table 45: POST /staged_config/remote_services Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
201 | The new staged remote service was successfully created. | |
409 | 1008 | The remote service name already exists in the selected group. |
422 | 1005 | A request parameter is invalid. |
500 | 1020 | An error occurred during the creation of the remote service. |
Response Description
The associated new created staged remote service object.
id - Long - The ID of the remote service.
name - String - The name of the remote service.
description - String - The description of the remote service.
group - String - The group to which the remote service belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote service.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}GET /staged_config/remote_services/{service_id}
Retrieves a staged remote service by ID.
Table 46: GET /staged_config/remote_services/{service_id} Resource Details
MIME Type |
|---|
application/json |
Table 47: GET /staged_config/remote_services/{service_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
service_id | path | Required | Number (Integer) | text/plain | ID that is used for the retrieval of a staged remote service. |
fields | query | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 48: GET /staged_config/remote_services/{service_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote service was successfully retrieved. | |
404 | 1002 | No staged remote service was found with the provided ID. |
500 | 1020 | An error occurred during the retrieval of the remote service. |
Response Description
The associated staged remote service object.
id - Long - The ID of the remote service.
name - String - The name of the remote service.
description - String - The description of the remote service.
group - String - The group to which the remote service belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote service.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}POST /staged_config/remote_services/{service_id}
Updates an existing staged remote service.
Table 49: POST /staged_config/remote_services/{service_id} Resource Details
MIME Type |
|---|
application/json |
Table 50: POST /staged_config/remote_services/{service_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
service_id | path | Required | Number (Integer) | text/plain | ID that is used for updating a staged remote service. |
fields | header | Optional | String | text/plain | Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets. Multiple fields in the same object are separated by commas. |
Table 51: POST /staged_config/remote_services/{service_id} Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
service | Object | application/json | null | { "cidrs": [ "String" ], "description": "String", "group": "String", "id": 42, "name": "String" } |
Table 52: POST /staged_config/remote_services/{service_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The staged remote service was successfully updated. | |
404 | 1002 | No staged remote service was found for the provided service ID. |
409 | 1008 | The remote service name already exists in the selected group. |
422 | 1005 | A request parameter is invalid. |
500 | 1020 | An error occurred during the update of the remote service. |
Response Description
The associated updated staged remote service object.
id - Long - The ID of the remote service.
name - String - The name of the remote service.
description - String - The description of the remote service.
group - String - The group to which the remote service belongs.
cidrs - Array of <String> - A list of all the CIDR ranges that belong to the remote service.
Response Sample
{ "cidrs": [ "String" ], "description":
"String", "group": "String", "id": 42, "name": "String"
}DELETE /staged_config/remote_services/{service_id}
Deletes an existing staged remote service.
Table 53: DELETE /staged_config/remote_services/{service_id} Resource Details
MIME Type |
|---|
text/plain |
Table 54: DELETE /staged_config/remote_services/{service_id} Request Parameter Details
Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
service_id | path | Required | Number (Integer) | text/plain | ID that is used for locating the staged remote service. |
Table 55: DELETE /staged_config/remote_services/{service_id} Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
204 | The staged remote service was successfully deleted. | |
404 | 1002 | No staged remote service was found for the provided service ID. |
500 | 1020 | An error occurred during the deletion of the remote service. |
Response Description
Response Sample
DELETE /staged_config/yara_rules
Deletes all Yara rules from the JSA system.
Table 56: DELETE /staged_config/yara_rules Resource Details
MIME Type |
|---|
text/plain |
There are no parameters for this endpoint.
Table 57: DELETE /staged_config/yara_rules Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
204 | Yara rules were successfully deleted from the system. | |
500 | 1020 | An error occurred during the attempt to delete the Yara rules. |
Response Description
In case of an error, the method returns an exception.
Response Sample
PUT /staged_config/yara_rules
Uploads the supplied Yara rule file to the JSA system. If the provided Yara file is empty - all rules are deleted from the system.
Table 58: PUT /staged_config/yara_rules Resource Details
MIME Type |
|---|
text/plain |
Table 59: PUT /staged_config/yara_rules Request Body Details
Parameter | Data Type | MIME Type | Description | Sample |
|---|---|---|---|---|
file | File | application/zip | Required - The Yara rule file. Must be properly-formed Yara rule content, either a TEXT file, or a TEXT file within a ZIP or TAR.GZ archive. Must be provided with MIME type text/plain, application/zip, application/x-gzip or multipart/form-data | File |
Table 60: PUT /staged_config/yara_rules Response Codes
HTTP Response Code | Unique Code | Description |
|---|---|---|
200 | The supplied Yara rule file was uploaded. | |
422 | 1101 | Must be a correctly-formatted Yara rule file. |
422 | 1103 | The archive file must only contain a single Yara rule file. |
422 | 1107 | Invalid archive file was provided. |
500 | 1104 | Failed to extract the contents of the archive file. |
500 | 1105 | Yara validator script was terminated owing to timeout. |
500 | 1106 | Yara validator script encountered an unknown exception. |
Response Description
In case of an error, the method returns an exception.