staged_config endpoints

Edit online

Use the references for REST API 19.0 staged_config endpoints.

GET /staged_config/access/security_profiles
Get the list of staged security profiles available in the system.
GET /staged_config/access/security_profiles/{id}
Get a staged security profile by ID.
GET /staged_config/access/user_delete_tasks/{task_id}
Retrieves the delete user task status.
GET /staged_config/access/user_roles
Get the list of staged user roles available in the system.
GET /staged_config/access/user_roles/{id}
Get a staged user role by ID.
GET /staged_config/access/users
Retrieves a list of all staged users.
POST /staged_config/access/users
Create a staged user.
DELETE /staged_config/access/users/{id}
Deletes a user from staging. To ensure safe deletion, dependencies are checked. This might take some time. An asynchronous task is started to do this check.
GET /staged_config/access/users/{id}
Retrieves a staged user.
POST /staged_config/access/users/{id}
Update a staged user.
GET /staged_config/backup_and_restore/scheduled_backup_configurations
Retrieves a list of the Staged Backup Configurations.
GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id}
Retrieves a Staged Backup Configuration by ID.
POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id}
Updates a Staged Backup Configuration.
GET /staged_config/certificates/certificate_signing_request
List of Certificate Signing Request (CSR) metadata that is stored in the certificate_signing_request database table.
POST /staged_config/certificates/certificate_signing_request
Creates a new Certificate Signing Request (CSR) file. A private key is generated and used to create the CSR file. The private key is kept secure on the Console. Use the GET call to download the CSR file. You must have System Administrator or Security Administrator permissions to use this endpoint.
DELETE /staged_config/certificates/certificate_signing_request/{id}
Deletes the Certificate Signing Request (CSR) resource.
GET /staged_config/certificates/certificate_signing_request/{id}
Download the generated Certificate Signing Request (CSR) file.
GET /staged_config/certificates/end_certificates
Gets the list of uploaded certificates from the staged area. You must have System Administrator, Security Administrator, Manage Log Sources, or WinCollect permissions to use this endpoint.
POST /staged_config/certificates/end_certificates
Use this endpoint to create a new certificate resource on the Console. This endpoint creates a keystore file that contains the supplied security objects. You must have System Administrator or Security Administrator permissions to use this endpoint. An administrator must deploy the configuration change.
DELETE /staged_config/certificates/end_certificates/{id}
Marks the certificate for deletion, but doesn't immediately remove it. You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /staged_config/certificates/end_certificates/{id}
Gets information about a specific certificate, as specified by the certificate ID. You must have System Administrator, Security Administrator, Manage Log Sources, or WinCollect permissions to use this endpoint.
POST /staged_config/certificates/end_certificates/{id}
Use this endpoint to update an existing certificate resource. You must have System Administrator or Security Administrator permissions to use this endpoint. After the certificate resource is updated, an administrator must deploy the updated Keystore file.
GET /staged_config/certificates/root_certificates
Gets the list of all of the root certificates that are uploaded. You must have System Administrator or Security Administrator permissions to use this endpoint.
POST /staged_config/certificates/root_certificates
Uploads a new single root certificate to the staged configuration folder on the Console.
DELETE /staged_config/certificates/root_certificates/{id}
Deletes a certificate from the staged configuration folder on the Console, but does not remove the certificate from the managed host. To remove the certificate from managed hosts, invoke this API and then deploy the configuration changes. You must have System Administrator permissions to use this endpoint.
GET /staged_config/certificates/root_certificates/{id}
Gets details of an uploaded root certificate, as specified by the ID. You must have System Administrator or Security Administrator permissions to use this endpoint.
GET /staged_config/deploy_status
Retrieves the status of a deploy in progress.
POST /staged_config/deploy_status
Executes a deploy.
GET /staged_config/deployment/hosts
Retrieves a list of all staged hosts.
GET /staged_config/deployment/hosts/{id}
Retrieves a staged host by ID. The Host object has the following fields:
GET /staged_config/deployment/hosts/{id}/tunnels
Gets the list of tunnels for the host.
POST /staged_config/deployment/hosts/{id}/tunnels/{name}
Updates a tunnel by host ID and tunnel name. The update is in the staged configuration and a deployment is needed. The only editable field is reverse_source. The default is false and can be set to true.
GET /staged_config/flow/applications/active_applications
Gets the list of active flow applications that are in the staged configuration area.
POST /staged_config/flow/applications/active_applications
Create a new active flow application in the staged configuration area.
DELETE /staged_config/flow/applications/active_applications/{id}
Removes the active flow application from the staged configuration area, as specified by the application ID.
GET /staged_config/flow/applications/active_applications/{id}
Gets an individual active flow application that is in the staged configuration area, as specified by the application ID. Active applications are flow applications that are currently in-use by the system. Active applications that are in the staged configuration area are not yet deployed. Changes or modifications to a flow application should always be made to the active applications list. Do not update the default applications. You must have System Administrator or Security Administrator permissions to use this endpoint.
POST /staged_config/flow/applications/active_applications/{id}
Updates an active flow application that is in the staged configuration area, as specified by the application ID.
GET /staged_config/remote_networks
Retrieves a list of staged remote networks.
POST /staged_config/remote_networks
Adds a new staged remote network.
DELETE /staged_config/remote_networks/{network_id}
Deletes an existing staged remote network.
GET /staged_config/remote_networks/{network_id}
Retrieves a staged remote network by ID.
POST /staged_config/remote_networks/{network_id}
Updates an existing staged remote network.
GET /staged_config/remote_services
Retrieves a list of staged remote services.
POST /staged_config/remote_services
Adds a staged remote service.
DELETE /staged_config/remote_services/{service_id}
Deletes an existing staged remote service.
GET /staged_config/remote_services/{service_id}
Retrieves a staged remote service by ID.
POST /staged_config/remote_services/{service_id}
Updates an existing staged remote service.
DELETE /staged_config/yara_rules
Deletes all Yara rules from the QRadar system.
PUT /staged_config/yara_rules
Uploads the supplied Yara rule file to the QRadar system. If the provided Yara file is empty - all rules are deleted from the system.