IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Access the API from the command line Access the API using the Elastic Cloud Terraform provider »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›How to access the API

Access the API using a REST application

edit

Access the API using a REST application

edit

You can interact with the full Elastic Cloud Enterprise API using a REST client application such as Postman. These steps show how to import the ECE OpenAPI specification into a client and then run API requests. This can be a convenient alternative to using either a terminal session or the Cloud UI to manage your deployments and the ECE platform.

Follow these steps to set up your REST application:

  1. If you don’t already have one, create an API key. If you are using a built-in account such as admin, you can use your account username and password to authenticate instead.

  2. Open a terminal and set $COORDINATOR_HOST to the address for the host that holds the coordinator role in your ECE installation. For example, in an AWS environment your coordinator host address would be in a format like ec2-x-xx-xxx-xx.compute-1.amazonaws.com:

    export COORDINATOR_HOST="ec2-x-xx-xxx-xx.compute-1.amazonaws.com"

  3. Run the following curl command to download the current API specification:

    • If you are using an API key:

      curl -o swagger.json  -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/api-docs/swagger.json

    • If you are using a system account such as admin:

      curl -o swagger.json -k -u admin:{yourpassword} https://$COORDINATOR_HOST:12443/api/v1/api-docs/swagger.json
  4. Visit the Postman download page and follow the instructions to install the application version that matches your operating system.

  5. Open Postman and click Import. Then, drag and drop your downloaded swagger.json file into the Upload Files field.

    The Import dialog and Upload Files field in Postman

  6. Leave all settings at the default values and click Import to add the API specification as a new collection. Since you’re not saving the document as an API, you can ignore the warning about needing to be signed in.

    The Confirm your import window in Postman

  7. Optionally, you can right-click on the imported collection and rename it to indicate the version level of the collection, for example Elastic Cloud Enterprise 2.8.0 API.

    The collection renamed to Elastic Cloud Enterprise 2.8.0 API
  8. Open the Environments tab, click Create a new Environment, and rename it to ECE API.
  9. Add a variable hostname and set the current value to your coordinator host, including the port number. For example, ec2-54-224-79-64.compute-1.amazonaws.com:12443.

  10. Click Save to apply the change. Note that in the following graphic, the Initial Value column is hidden for clarity. You need to set only the Current Value.

    The Environments tab
  11. Open the Collections tab, hover over the Elastic Cloud Enterprise collection, and click View more actions → Edit.

  12. Under the Variables tab:

    1. Confirm that baseUrl is set to https://{{hostname}}/api/v1/. This variable should be set by default. Any other variables can be deselected.

      The Edit Collection window

  13. Under the Authorization tab:

    • If you are using an API key:

      1. Set Type to API Key.
      2. Set Key to Authorization.
      3. Set Value to ApiKey plus the value of your key, for example ApiKey V0VtQnEzY0Jpd2l6dk10RW9SeXQ6ajNjSDY2b0FUVldtVHJmTTgxQ2hKQQ==.

      4. Set Add to to Header.

        API Key authorization with Key

    • If you are using a system account such as admin:

      1. Set Type to Basic Auth.
      2. Set Username to admin or your account username.

      3. Set Password to your account password.

        Basic Auth authorization with Username and Password set
      4. Save your settings.

Now that the Postman application has been configured to work with the Elastic Cloud Enterprise API, you can try a test API request:

  1. Make sure that the drop-down box for your environment is set to ECE API.

    ECE API environment is selected

  2. Expand the Elastic Cloud Enterprise collection, scroll to the deployments section, and click the List Deployments GET request.

    The 'List Deployments' GET request in the request collection
  3. Click Send.

  4. If the request connects successfully, the status pane shows a status of 200 OK along with the response time and response size. The Body tab displays the JSON response from the API.

    The status for the submitted request showing '200 OK' and the JSON response

  5. You’ll use part of this JSON response for our next API request. Copy the value of id from the deployments instance.

    The 'id' value in the 'deployments' instance of the JSON response
  6. Expand the Elastic Cloud Enterprise collection, and under deployments → {deployment id} click the Get Deployment GET request.

  7. Note that the request includes a deployment_id path variable.

    Details for the Get Deployment request
  8. You can try a test run of the Get Deployment request. The request should fail with a requested resource could not be found error because the required deployment_id variable is not set.

  9. Under Path Variables:

    1. Set deployment_id to the value for id that was returned in the previous List Deployments GET request.

      Details for the Get Deployment request
  10. Click Send.
  11. If the request connects successfully, the status pane shows a status of 200 OK and the Body tab displays the JSON response from the API, with details about the deployment configuration and its current state.

You can now use all of the other requests available in the collection that you created from the Elastic Cloud Enterprise OpenAPI specification. To learn more about all of the available API endpoints, see the API reference and examples.

« Access the API from the command line Access the API using the Elastic Cloud Terraform provider »