Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

APIs

Apstra ConnectorOps exposes a REST API for pulling rendered SRX configurations and operational data. The API is exposed on the ConnectorOps VM/host/server at http://<ConnectorOps-VM-IP:<VM-Port>/. The VM port is the host-side port you specify in the docker-compose.yml. The following are the API endpoints:

Note: You must provide the username and password of your Apstra setup to authenticate ConnectorOps REST API calls.
  • All Blueprints: http://<ConnectorOps-VM-IP>:<VM-Port>/api/renderconfig
  • Per Blueprint: http://<ConnectorOps-VM-IP:<VM-Port>/api/renderconfig/<BluePrintID>
  • Per device: http://<ConnectorOps-VM-IP>:<VM-Port>/api/renderconfig/<BluePrintID>/device/<DeviceName>

Response codes:

  • 200: OK

  • 401: Invalid username or password

  • 500: For Invalid SRX Device Names and BluePrint ID


Postman interface showing a GET request to an API endpoint with Basic Auth. The JSON response includes system configuration details like Blueprint ID, UDP application settings, high-availability chassis parameters, and redundancy group settings. Response status is 200 OK, time 714 ms, size 27.68 KB.