Version: v1

ZeyOS OAuth 2.0 API

Authentication

HTTP: Basic Auth

HTTP Basic Authentication (RFC 7617)

Security Scheme Type:	http
HTTP Authorization Scheme:	basic

HTTP: Bearer Auth

HTTP Bearer Authentication (RFC 6750)

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer

API Key: session

Session Cookie Authentication (RFC 6265)

Security Scheme Type:	apiKey
Header parameter name:	ZEYOSID

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

Content from authapi introduction.mdx

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

The ZeyOS OAuth 2.0 API handles authentication and session management for all ZeyOS cloud services. Use it to obtain bearer tokens for the REST API and to manage user sessions programmatically.

Base URL

All Auth API endpoints are available at:

Text

https://cloud.zeyos.com/{INSTANCE}/auth/v1/

Replace {INSTANCE} with your ZeyOS instance name.

Authentication Methods

ZeyOS supports three authentication methods:

Method	Use case
HTTP Basic Auth	Initial token request — pass your username and password to /auth/v1/token
HTTP Bearer Token	Authenticate subsequent API calls — include Authorization: Bearer {token} in every request
Session Cookie	Browser-based sessions — the ZEYOSID cookie is set automatically after login

Getting a Token

Exchange your credentials for a bearer token using the /token endpoint:

Bash

curl -X POST \
  -u "username:password" \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/token

The response contains an access_token you can use in the Authorization header for all REST API requests.

Token Lifecycle

• Tokens expire after a configurable period (default: 24 hours).
• Use the /token/introspect endpoint to check whether a token is still active.
• Use the /token/revoke endpoint to invalidate a token explicitly (e.g. on logout).

OpenAPI Specification

The Auth API is published as a machine-readable OpenAPI document:

• /__doc/openapi/oauth2.json — Auth API specification (alias: /openapi.oauth2.json)

Contact

ZeyOS GmbH & Co. KG: [email protected]

URL: https://www.zeyos.com

Terms of Service

https://www.zeyos.com/termsofservice