Welcome to our docs site. Docs on this site are for ACP version 9.
See these links for previous versions: Version 8, Version 7

Making a Request to an Apprenda REST API

Apprenda REST API resources are accessed by sending an HTTP request to your Apprenda environment. The Platform then replies with a response that either contains the data you requested, a status indicator, or both. All requests require proper Authentication with active user credentials that has permissions or securables to perform the action in the request.

For all requests where a response is expected the Content-Length HTTP header should be set to either the length of the response or “0”. Additionally, the client making the request must use a SSL/TLS protocol that matches one allowed by the Platform.

Verbs

All requests must contain a verb (or request method) that corresponds to the action they are attempting to perform for a particular resource. In general, verbs used in requests are:

  • GET: Read information about an existing resource. All resource roots implement GET
  • POST: Create a resource. In some cases POST is used to partially update a resource
  • DELETE: Remove a resource. Once a resource is deleted, the action cannot be undone (although in most cases the resource can be recreated)
  • PUT: Update a resource. Desired values for all updateable fields should be included in the content of a PUT request; it cannot be used for partial updates Paths

Rest URLs

All resources are located at the base URL of [CloudURI]/[soc,developer,account]/api/v1. CloudURI is the root URI for your Platform and soc, developer, and account represent the REST API you are using.

For example, if the CloudURI of your Platform instance is http://apps.apprenda.harp and you are trying to use the Platform Operations REST API, resources would be located at http://apps.apprenda.harp/soc/api/v1.

To make a request for a particular resource, append a specific path to this base URL that specifies the resource. The path necessary to access a particular resource can be found in the reference documentation for each API

Queries

For some requests a query or queries can be appended to the path of a resource. Applicable queries for a particular resource can be found in the Resource Reference. Properties and Linked Resource URLs

As noted above, REST API resources and their entries in the Resource Reference have been organized around resource roots that correlate to Platform elements such as servers. For some resources, related properties have been included in the Resource Reference along with a brief explanation and acceptable property values to help you understand the elements affected by a request. These properties can be as simple as a Name or Description, but also may entail Platform-specific constructs such as Server State or assigned Resource Policy. When practical, links to our Platform documentation have been provided to help contextualize these properties.

Properties of a particular resource root are in general returned when a GET request is made on a related resource. It may also be necessary to supply values for some properties in the body of a request when creating or updating a resource.