Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY emails API

EmailController Operations about Email

XSKY emails API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include emails. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.

Requests are made against the base URL https://{xms-controller}/v1.

3 operations 2 paths 8 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY emails API declares 2 security schemes for authenticating requests. An API key is passed in the header as Xms-Auth-Token (tokenInHeader). An API key is passed in the query as token (tokenInQuery).

  • tokenInHeader — auth by token
  • tokenInQuery — auth by token

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

emails 3

EmailController Operations about Email

POST
/emails/
send email
SendEmail 1 param → 200400500
GET
/emails/config
setup email configs
GetEmailConfig → 200400500
PATCH
/emails/config
setup email configs
UpdateEmailConfig 1 param → 200400500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are EmailConfigUpdateReq_EmailConfig (8 properties), EmailConfig (8 properties), Email (5 properties), EmailSendReq_Email (3 properties). Each schema is shown below with its type and property counts.

EmailSendReq
object
EmailSendReq defines the data of email sending
2 properties
EmailSendReq_Email
object
3 properties 2 required
EmailResp
object
1 property
EmailConfigResp
object
1 property
EmailConfig
object
EmailConfig define email config
8 properties
Email
object
Email defines email model
5 properties
EmailConfigUpdateReq_EmailConfig
object
8 properties
EmailConfigUpdateReq
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-emails-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY auth API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API