Tenant API reference

Connection

Base URL: https://client.oceanmail.co. Send Authorization: Bearer <token> over HTTPS. The request source IP must be on the allowlist.

1. Prepare a token owned by a tenant administrator with API permission and an allowlisted outbound IP.
2. Send requests over HTTPS to the base URL https://client.oceanmail.co.
3. Supply the token in the Authorization: Bearer header, never in the URL.

Endpoints

1. GET /api/v1/tenant/profile/ — retrieve tenant ID, type and name.
2. GET /api/v1/tenant/services/ — retrieve service status, capacity and source.
3. GET /api/v1/tenant/domains/ — retrieve domains and ownership TXT information.
4. POST /api/v1/tenant/domains/ — attach a domain to an eligible active service with service_id and domain JSON fields.

Pagination and security

Lists return up to 100 results. Pass next_after as the after query parameter for the next page. Do not put an API token in a URL, screenshot or support ticket.

1. Inspect next_after in the first list response.
2. Pass that value as the after query parameter for the next page; each page has at most 100 results.
3. Keep the token out of URLs, screenshots and support requests.