REST API

Seamlessly integrate Appetize into your CI/CD pipeline by making use of our REST API.

🚀 Getting Started

Private Instance Users If you're using a Private Enterprise Instance, update the domain for your requests:

• For v1 APIs, use: https://custom.appetize.io

• For v2 APIs, use: https://custom.appetize.io/api/

1. Get Your API Token

To authenticate your requests:

• Log in to your Appetize account.

• Navigate to Organization → API Token to generate your API token.

Only users with admin or developer roles can access API tokens.

2. Authenticate Your Requests

Use the X-API-KEY header to authenticate every API request.

cURL

curl -X GET https://api.appetize.io/v1/apps \
  -H "X-API-KEY: your_api_token"

JavaScript

fetch("https://api.appetize.io/v1/apps", {
  headers: {
    "X-API-KEY": "your_api_token"
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

3. Explore our API

You’re all set to start using the API.

Each endpoint includes:

• 📦 Sample requests and responses

• 🌐 Code samples in multiple languages (like cURL, Python, JavaScript)

Use these to quickly understand how each endpoint works and integrate it into your own tools.

Format & Conventions

• POST requests must include a Content-Type: application/json header.

• All responses are in JSON format.

Response Codes

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.