In this section
Assign agent resources policy
Assigns agent resource policies.
Assign agent resources profiles
Assigns agent resource profiles.
Attach gateway to management profile
Attaches a gateway to a management profile and generates an activation token. The generated activation token is used in gateway registration.
Configure gateway external proxy connection
Configures the external proxy connection on the gateway.
An access token must be generated to use this API.
Create management profile
Creates a management profile.
Detach gateway from management profile
Unmaps, or detaches, the gateway from the management profile and invalidates the activation token.
Download gateway files
Downloads gateway files from the download server.
Download Linux agent
Downloads the Linux agents.
This usually follows calling the Get Agent Package for Linux API.
- To capture the agent file: Use the package name from the response headers with the specific header package-name. The content of the file is available in the response body.
- Create a file with the same name as provided in the header and then write the contents of the response body into the file.
Download Linux agent installation script
Downloads the Linux agent installation script.
This returns the JSON payload containing package name, package size, package checksum, and the package S3 bucket URL to directly download the agent.
Download Windows agent
Downloads the Windows agent.
This returns the JSON payload containing package name, package size, package checksum, and the package S3 bucket URL to directly download the agent.
Generate gateway access token
Generates an access token on the gateway.
An access token is needed to:
- Register the gateway.
- Use all gateway-related activities.
- Provides a secured connectivity with OpsRamp cloud
Get agent count by agent version
Gets the number of installed agent resources by agent version.
Get status, start and stop application services
Gets the service status and starts and stops application services.
An access token must be generated to use this API.
Supported services are network, squid, postgresql, vprobe, and ntp.
Get the Linux agent
Gets the Linux agent. This is usually followed by an API call to Download Linux Agent.
Returns the JSON payload containing package name, package size, package checksum. The response also contains package S3 bucket URL for downloading the agent directly.
Gets gateway information
Gets general information from the gateway, including appliance details and network information.
Gets gateway NGINX status and restart service
Gets the NGINX service status and restarts the NGINX service on the gateway.
Gets gateway NTP details
Gets NTP details from the gateway.
Gets gateway timezone information
Gets timezone information from the gateway.
Manage management profile
Gets, updates, and deletes a management profile.
Manually set gateway NTP date and time
Manually sets the NTP date and time on the gateway.
Reconnect management profile tunnel
Reconnects the management profile tunnel.
Register gateway
Registers the gateway.
Restart network service
Restarts the gateway network service.
Search for management profile
Searches for a management profiles.
Query Variables
| Variable | Value | Description |
|---|---|---|
| id | {id} | The management profile ID. |
| name | {name} | The management profile name. |
| type | Agent, Gateway | The anagement profile type. An example is: Agent. |
| startCreationDate | {startCreationDate} | Search for the management profile created within a certain duration. Start indicates the from date. An example is: 2016-06-10T10:40:20 0000 (GMT). |
| endCreationDate | {endCreationDate} | Search for the management profile created within a certain duration. End indicates the to date. An Example is: 2016-06-20T10:40:20 0000 (GMT). |
Notes
- Special characters in the query string
- Plus (+) indicates next field and must be URL encoded.
- Color (:) indicates Equals. An example is: key: value.
- Space characters must be URL encoded.
- Date format must use this format: yyyy-MM-ddTHH: mm: ssZ (GMT).
Set gateway timezone
Sets the gateway timezone.
Set static route configuration
Sets the gateway static route configuration.
Specifies gateway network settings
Specifies the network settings on the gateway.
Start and stop gateway NTP service
Starts and stops the gateway NTP service.
Synchronize NTP servers time
Synchronizes gateway NTP servers time.
Turn Squid proxy service on and off
Turn the gateway Squid proxy server on and off.
Update gateway NTP server IP addresses
Updates gateway NTP server IP addresses.