Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.74 KB

README.md

File metadata and controls

44 lines (34 loc) · 1.74 KB
Raw
description icon
Seamlessly integrate Appetize into your CI/CD pipeline by making use of our REST API.
cloud

REST API

Getting Started

{% hint style="warning" %} If you are using an Enterprise Private Instance of Appetize, please replace all API calls from api.appetize.io to your custom domain, e.g. custom.appetize.io. {% endhint %}

  1. Get Your API Token
    All users with admin or developer roles may request an API token after logging in and navigating to Organization -> API Token.
  2. Use Basic Authentication:
    When sending requests to the Appetize REST API that requires authentication, use Basic Authentication.
  3. Encode your token + ":" using Base64 encoding.
  4. Attach Token to Requests
    In your HTTP headers, include an Authorization header with the value "Basic" followed by the encoded token.

See our Sample Code for an example on how to get started.

HTTP Requests

{% hint style="info" %} All HTTP POST Requests must use JSON. {% endhint %}

HTTP Responses

{% hint style="info" %} All HTTP Responses will be in JSON. {% endhint %}

Status code Details
200 OK - Everything worked as expected.
400 Bad Request - Often missing a required parameter.
401 Unauthorized - No valid API token provided.
404 Not Found - No app found for publicKey specified.
500, 502, 503, 504 Server error - something went wrong on our server.