REST API endpoints

TrueSight Server Automation provides API endpoints to perform all the tasks that are supported by the application. The API follows the REST architectural style and uses resources, HTTP verbs, and status codes. JavaScript Object Notation (JSON) is used to represent data structures in request and response bodies.

You can explore these REST APIs using Swagger or use any other utility such as Postman or curl. For information about using the Swagger UI, see Trying out the REST APIs.

batch jobs NEW IN 21.02

Contains APIs for running and deleting batch jobs and retrieving batch job details.

API callDescription

GET /api/v1/batch-jobs

Retrieves the details of all the batch jobs that match the specified filter criteria.

GET /api/v1/batch-jobs/{id}

Retrieves the batch job details for a specific job ID.

DELETE /api/v1/batch-jobs/{id}

Deletes the specified batch job.

PATCH /api/v1/batch-jobs/{id}

Runs the batch job for a specific job ID.

GET /api/v1/batch-jobs/{id}/jobruns

Retrieves the list of all batch jobs for a specified job id.

GET /api/v1/batch-jobs/{id}/jobruns/{run_id}

Retrieves a specific batch job run along with the child job runs.

PATCH /api/v1/batch-jobs/{id}/jobruns/{run_id}/abort

Aborts a specific instance of a job run.

PATCH /api/v1/batch-jobs/{id}/jobruns/{run_id}/cancel

Cancels a specific instance of a job run.

GET /api/v1/batch-jobs/{id}/jobruns/{run_id}/events

Retrieves the list of all batch job run event details for a specific job ID and the associated job run ID.

PUT /api/v1/batch-jobs/{id}/schedules

Updates the schedules for a specific batch job ID.

POST /api/v1/batch-jobs

Creates a batch job for a specified request. The batch job runs on the common targets for all the member jobs that are provided during the request. Targets for individual jobs are not supported.

bl-packages NEW IN 8.9.04.003

Contains APIs for retrieving blpackages.

API callDescription

GET /api/v1/blpackages

Retrieves the details of blpackages.

GET /api/v1/blpackages/{id} NEW IN 20.02

Retrieves the details of blpackages.

catalogs

Contains APIs for retrieving, updating, or running patch catalogs.

API callDescription

GET /api/v1/catalogs

Retrieves the catalog details.

PATCH /api/v1/catalogs/{id}

Retrieves the list of all patch catalogs created for all the operating systems.

GET /api/v1/catalogs {id}/containers

Retrieves the list of all patch containers in a specific catalog.

GET /api/v1/catalogs/{id}/jobruns

Retrieves the list of all job runs for a specified catalog ID.

GET /api/v1/catalogs/{id}/jobruns/{run_id}

Retrieves the catalog job run details for the specific catalog ID and the associated job run ID.

GET /api/v1/catalogs/{id}/jobruns/{run_id}/events

Retrieves the list of all catalog job run event details for the specific catalog ID and the associated job run ID.

GET /api/v1/catalogs/{id}/patches DEPRECATED IN 21.02

Retrieves the list of all patches in catalogs. Incompatible filters are ignored.

GET /api/v2/catalogs/{id}/patches

Retrieves the list of all patches in catalogs. Incompatible filters are ignored.

compliance-jobs NEW IN 21.02

Contains APIs for retrieving, creating, and updating compliance jobs.

API callDescription

POST /api/v1/compliance-jobs

Creates a compliance job for the specified request.

GET /api/v1/compliance-jobs/{id}

Retrieves the compliance job details for a specific job ID.

DELETE /api/v1/compliance-jobs/{id}

Deletes a compliance job.

GET /api/v1/compliance-jobs/{id}/jobruns

Retrieves the list of all job runs for a specified compliance job ID.

GET /api/v1/compliance-jobs/{id}/jobruns/{run-id}

Retrieves the compliance job run details for the specific job ID and the associated job run ID.

GET /api/v1/compliance-jobs/{id}/jobruns/{run_id}/events

Retrieves the list of all compliance job run event details for the specific job ID and the associated job run ID.

GET /api/v1/compliance-jobs/{id}/jobruns/{run_id}/results/rules

Retrieves the compliance job rule results for the specific job ID and the associated job run ID for the list of servers.

GET /api/v1/compliance-jobs/{id}/jobruns/{run_id}/results/servers

Retrieves the compliance job results for the specific job ID and the associated job run ID for the list of servers.

PUT /api/v1/compliance-jobs/{id}/schedules

Updates schedules for the specified compliance job ID.

POST /api/v1/compliance-jobs/remediate

Creates a compliance remediation job.

POST /api/v1/compliance-jobs/remediate-async

Creates an asynchronous compliance remediation job.

GET /api/v1/compliance-jobs/remediate-async/{cacheKey}

Retrieves a response from the created asynchronous remediation job.

PATCH /api/v1/compliance-jobs/{id} 

Runs the compliance job for a specified job ID.

configs

Contains APIs for TrueSight Server Automation configuration.

API callDescription

GET /api/v1/configs/timezones

Retrieves the list of all the supported timezones.

GET /api/v1/configs/automation_console NEW IN 21.02

Retrieves the blasadmin setting details related to the TrueSight Automation Console login.

deploy-jobs

Contains APIs for retrieving, creating, running, or deleting Software Deploy and BLPackage Deploy jobs.

API callDescription

POST /api/v1/deploy-jobs

Creates a deploy job for the specified request.

DELETE /api/v1/deploy-jobs/{id}

Deletes a deploy job.

PATCH /api/v1/deploy-jobs/{id}

Runs deploy jobs for a specific job ID.

GET /api/v1/deploy-jobs/{id}/jobruns

Retrieves the list of all deploy job runs for a specified job ID.

GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}

Retrieves the deploy job run details with all its child job runs for the specific job ID and the associated job run ID.

GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}/events

Retrieves the list of all deploy job run event details with all its child job runs for the specific job ID and the associated job run ID.

GET /api/v1/deploy-jobs/{id}/jobruns/{run_id}/results

Retrieves the deploy job results for the specific job ID and the associated job run ID.

PUT /api/v1/deploy-jobs/{id}/schedules NEW IN 20.02

Updates the deploy schedule requests.

PATCH /api/v2/deploy-jobs/{id} NEW IN 20.02

Runs deploy jobs for a specific job ID.

PATCH /api/v1/deploy-jobs/{id}/jobruns/{run_id}/abort NEW IN 20.02.01

Aborts a specific instance of a job run for the running job.

PATCH /api/v1/deploy-jobs/{id}/jobruns/{run_id}/cancel NEW IN 20.02.01

Cancels a specific instance of a job run for the running job.

GET /api/v1/deploy-jobs NEW IN 21.02

Retrieves the details of all deploy jobs according to the specified filter criteria.

execution-tasks NEW IN 21.02

Contains APIs for retrieving, creating, executing, or deleting execution tasks.

API callDescription

GET /api/v1/execution-tasks

Retrieves the details of execution tasks according to the specified filter criteria.

POST /api/v1/execution-tasks

Creates an execution task for a specified request.

GET /api/v1/execution-tasks/{id}

Retrieves the execution task for a specific execution task ID.

PUT /api/v1/execution-tasks/{id}

Updates a specific execution task.

DELETE /api/v1/execution-tasks/{id}

Deletes the specified execution task.

PATCH /api/v1/execution-tasks/{id}

Executes the execution task for a specified ID.

groups

API callDescription

GET /api/v1/groups/{type}

Retrieves the list of all groups for a specified type.

POST /api/v1/groups/{type}

Creates a group with a specified type.

PUT /api/v1/groups/{id}

Updates a group with a specified group ID.

metrics NEW IN 20.02.01

Contains APIs for retrieving the metrics data of Application Servers.

Important

These APIs are available only on the Maintenance Server instance. They are not available on the Configuration or Job Server instances. 


API callDescription

GET /api/v1/metrics/{param}

Retrieves the metrics of all deployments for the specified parameter.

GET /api/v1/metrics/{param}/{deploymentId}

Retrieves the metrics for the specified parameter and deployment.

GET /api/v1/metrics/24hours/{param}

Retrieves the metrics of all deployments for the specified parameter for the last 24 hours.

GET /api/v1/metrics/all

Retrieves the metrics of all Application Servers.

GET /api/v1/metrics/deployment/{deploymentId}

Retrieves the metrics of the specified deployment.

GET /api/v1/metrics/last1krecs

Retrieves the record of last 1000 metrics of all deployments.

GET /api/v1/metrics/listalldeployments

Retrieves all deployments of the configured system.

GET /api/v1/metrics/listAllJobsWaiting

Retrieves the list of all jobs that are waiting to be run.

GET /api/v1/metrics/listAllParameters

Retrieves the list of all parameters that are available under metrics.

GET /api/v1/metrics/listDBServiceDetails

Retrieves the database service details of all deployments of the configured system.

GET /api/v1/metrics/listInfraDetails

Retrieves the infrastructure details of all deployments of the configured system.

GET /api/v1/metrics/listJobManagerServiceDetails

Retrieves the job manager details of all deployments of the configured system.

GET /api/v1/metrics/db/statistics NEW IN 21.02

Retrieves all the available database statistics.

GET /api/v1/metrics/dbcleanup/configs NEW IN 21.02

Retrieves the blasadmin configurations of the Maintenance Server.

GET /api/v1/metrics/dbcleanup/dailycleanupinfo NEW IN 21.02

Retrieves the number of records that were deleted during the last daily cleanup run.

GET /api/v1/metrics/dbcleanup/history NEW IN 21.02

Retrieves the history of records that were deleted in the daily cleanup runs.

GET /api/v1/metrics/dbcleanup/weeklycleanupinfo NEW IN 21.02

Retrieves the number of records that were deleted in the last weekly cleanup run.

nsh-script-jobs

Contains APIs for retrieving, creating, running, or deleting nsh script jobs.

API callDescription

POST /api/v1/groups/{type}

Creates a group with a specified type.

PUT /api/v1/groups/{id}

Updates a group with a specified group ID.

POST /api/v1/nshscript-jobs

Creates nsh script job for a specified request.

DELETE /api/v1/nshscript-jobs/{id}

Deletes nsh script job.

PATCH /api/v1/nshscript-jobs/{id}

Runs nsh script job for a specific job ID.

GET /api/v1/nshscript-jobs/{id}/jobruns

Retrieves the list of all job runs for a specified nsh script job ID.

GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}

Retrieves the nsh script job run details for the specific job ID and the associated job run ID.

GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/events

Retrieves the list of all nsh script job run event details for the specific job ID and the associated job run ID.

GET /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/results

Retrieves the nsh script job results for the specific job ID and the associated job run ID.

PUT /api/v1/nshscript-jobs/{id}/schedules

Updates the nsh script job schedules.

PATCH /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/abort NEW IN 20.02.01

Aborts a specific instance of a job run for the running job.

PATCH /api/v1/nshscript-jobs/{id}/jobruns/{run_id}/cancel NEW IN 20.02.01

Cancels a specific instance of a job run for the running job.

GET /api/v1/nshscript-jobs NEW IN 21.02

Retrieves the details of all nsh script jobs according to the specified filter criteria.

nsh scripts

Contains APIs for retrieving nsh scripts.

API callDescription

GET /api/v1/nshscripts

Retrieves the list of all nsh scripts.

GET /api/v1/nshscripts/{id}

Retrieves the list of specific nsh scripts.

patching-jobs

Contains APIs for retrieving, creating, updating, running, or deleting patching jobs.

API callDescription

GET /api/v1/patching-jobs

Retrieves the details of all patching jobs, matching any filter criteria.

POST /api/v1/patching-jobs

Creates a patching job for a specified request.

GET /api/v1/patching-jobs/{id}

Retrieves the patching job details for a specific job ID.

PUT /api/v1/patching-jobs/{id}

Updates a specific patching job.

DELETE /api/v1/patching-jobs/{id}

Delete a patching job.

PATCH /api/v1/patching-jobs/{id} DEPRECATED IN 21.02

Runs the patching job for a specific job ID.

PATCH /api/v2/patching-jobs/{id} NEW IN 21.02

Runs the patching job for a specific job ID.

GET /api/v1/patching-jobs/{id}/jobruns

Retrieves the list of all job runs for a specified patching job ID.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}

Retrieves the patching job run details with all its child job runs for the specific job ID and the associated job run ID.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/events

Retrieves the list of all patching job run event details with all its child job runs for the specific job ID and the associated job run ID.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results

Retrieves the patching Job result details with its child job runs for the specific job ID and the associated job run ID.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/analysis

Retrieves the patching job analysis results for the specific job ID and the associated job run ID.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/analysis/servers

Retrieves the patching job analysis results for the specific job ID and the associated job run ID for list of servers.

GET /api/v1/patching-jobs/{id}/jobruns/{run_id}/results/remediation

Retrieves the patching job remediation results for the specific job ID and the associated job run ID.

PUT /api/v1/patching-jobs/{id}/schedules

Updates schedules for a specific patching job ID.

PATCH /api/v1/patching-jobs/{id}/jobruns/{run_id}/abort NEW IN 20.02.01

Aborts a specific instance of a job run for the running job.

PATCH /api/v1/patching-jobs/{id}/jobruns/{run_id}/cancel NEW IN 20.02.01

Cancels a specific instance of a job run for the running job.

roles

Contains APIs for retrieving, creating, updating, or deleting roles.

API callDescription

GET /api/v1/roles

Retrieves the list of all roles.

servers

Contains APIs for enrolling, decommissioning, and retrieving details of servers, or updating their properties.

API callDescription

GET /api/v1/servers

Retrieves the details of all servers, matching any filter criteria. This list also includes the decommissioned servers.

GET /api/v1/servers/{id}

Retrieves the details of the server for a specified ID.

sessions

Contains APIs for session management.

API callDescription

GET /api/v1/sessions

Retrieves the details for a specific session ID.

POST /api/v1/sessions

Creates an authentication token that contains the credentials and permissions for the user, and is required for all subsequent operations.

DELETE /api/v1/sessions

Terminates the validity of a session token and the user is logged off from the application.

POST /api/v1/sessions/pki NEW IN 21.02

Creates an authentication token for PKI that contains the credentials and permissions for the user. This token is required for all subsequent operations.

smart-groups

Contains APIs for creating, updating, or retrieving details of smart groups.

API callDescription

GET /api/v1/smart-groups/{type}

Retrieves the list of all smart groups for a specified type.

GET /api/v1/smart-groups/{type}/{id}/members

Retrieves the details of the server for a specified ID.

templates

Contains APIs for retrieving the list of compliance templates.

API callDescription

GET /api/v1/templates

Retrieves the list of all compliance templates.

GET /api/v1/templates/{id}

Retrieves the compliance template for a specified ID.
Was this page helpful? Yes No Submitting... Thank you

Comments