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 email-groups API

EmailGroupController Operations about Email

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

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

This API exposes 5 operations across 2 paths, and defines 6 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.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 POST1 PUT

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 email-groups 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 5

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

email-groups 5

EmailGroupController Operations about Email

GET
/email-groups/
List all email groups
ListEmailGroups 4 params → 200400500
POST
/email-groups/
create email group
CreateEmailGroup 1 param → 200400500
GET
/email-groups/{group_id}
get email group
GetEmailGroup 1 param → 200404500
PUT
/email-groups/{group_id}
update email group
UpdateEmailGroup 2 params → 200400500
DELETE
/email-groups/{group_id}
delete email group
DeleteEmailGroup 1 param → 204400404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are EmailGroup (5 properties), EmailGroupUpdateReq_EmailGroup (2 properties), EmailGroupResp (1 property), EmailGroupsResp (1 property). Each schema is shown below with its type and property counts.

EmailGroupUpdateReq_EmailGroup
object
2 properties 2 required
EmailGroupUpdateReq
object
1 property 1 required
EmailGroupsResp
object
1 property 1 required
EmailGroupRecord
EmailGroupRecord defines email group record
EmailGroupResp
object
1 property 1 required
EmailGroup
object
EmailGroup defines the email group
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-email-groups-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