REST API reference

The following describes the REST API specification in ALM Octane. The principles guiding the specification follow the basic REST guidelines that were introduced by Roy Fielding. For details, see Representational State Transfer (REST)

Public vs. non-public resources

For a list of public, supported resources, see the ALM Octane Developer Guide.

Other resources are a technical preview, and subject to change until declared public.

Accessing public resources Accessing non-public resources
You do not need to send any additional headers; only the content-type header is necessary.

Send requests with a header:

Header:  HPECLIENTTYPE

Value: HPE_REST_API_TECH_PREVIEW

Guidelines

Variables and values

Providing input to server

Receiving output from server

Status codes

Cookies