Cycloid.io (0)

Download OpenAPI specification:Download

Authentication

api_key

The API authorization is done with JWT tokens

Security Scheme Type API Key
Header parameter name: Authorization

Cycloid

Operation related to Cycloid's application.

getStatus

Get the status of the Cycloid's services.

Responses

200

General application status and services statuses.

422

All the custom errors that are generated from the Cycloid API

default

The response sent when an unexpected error happened, as known as an internal server error.

get/status
https://http-api-stoplight.cycloid.io/status

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

getAppVersion

Get the version of the Cycloid's API.

Responses

200

Application version.

422

All the custom errors that are generated from the Cycloid API

default

The response sent when an unexpected error happened, as known as an internal server error.

get/version
https://http-api-stoplight.cycloid.io/version

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Organizations

Operations for organizations.

getOrgAncestors

Get all the ancestors between the Organization and the User with the shortest path.

Authorizations:
path Parameters
organization_canonical
required
string [ 3 .. 30 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Responses

200

Get all the ancestors between the Organization and the User with the shortest path. 0 index is the parent and n is the searched child

401

The user cannot be authenticated with the credentials which she/he has used.

default

The response sent when an unexpected error happened, as known as an internal server error.

get/organizations/{organization_canonical}/ancestors
https://http-api-stoplight.cycloid.io/organizations/{organization_canonical}/ancestors

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data":
    [