Security Controls REST API

Home 

API Overview

Request URLs

The console machine will only respond to REST API requests that include proper authentication credentials.

Each resource collection in this RESTful API is identified by a unique URL. For example:

https://<consoleFQDN:port>/st/console/api/v1/machinegroups

<consoleFQDN:port> is unique for each installation and represents the hostname of your console machine, your domain name and the port used to access the console. For example: mymachine.somedomain.com:3121.

v1 is the version specifier and must be present. When significant changes are made to the API (changes that would break compatibility with existing applications), this value will change.

Request/Response Format

All requests and responses are delivered in JavaScript Object Notation (JSON) format, a lightweight serialization language that is compatible with many different languages.

HTTP/HTTPS Methods

Standard HTTP/HTTPS methods are used to denote actions against a resource.

GET: Reads a resource

POST: Creates a new resource

PUT: Updates a resource

DELETE: Deletes a resource

Any web programming language (Ruby, PHP, Perl, Python, Java, Objective C, C#) can make and receive HTTP/HTTPS networking calls.

Standard Response Codes

Conventional HTTP/HTTPS response codes are used to indicate the success or failure of an API request.

2xx range codes indicate success

4xx range codes indicate an error that resulted from the caller-provided information (e.g. a required parameter was missing, a charge failed, etc.)

5xx range codes indicate an error with the server

Error Policy

Errors are returned using standard HTTP/HTTPS error code syntax. Any additional information is included in the body of the return call in a JSON format.

You can specify how errors will be handled by adding an ErrorPolicy parameter to the body input of applicable requests.

ErrorPolicy=Throw means the entire request will be rejected

ErrorPolicy=Omit means the problem area will be omitted but the rest of the request will be completed. Omit is the default value.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other