Introduction

The Codex API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

All requests in must go through Codex API base domain

https://api.codex.gjirafa.tech/

Authentication

The Codex API uses API keys to authenticate requests. You can view and manage your API keys in the Codex API Keys Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via bearer auth. Provide your personal token or API key as the bearer auth value. You do not need to provide a password.

curl https://api.codex.gjirafa.tech/v2/{organization}/sites -H "Authorization: Bearer {TOKEN_OR_API_KEY}"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.