Documentation Powered by ReDoc

Cycloid.io (0)

Download OpenAPI specification:Download

E-mail: contact@cycloid.io URL: http://cycloid.io License: Cycloid @copyrights

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.

Authorizations:
api_key

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":
    {
    }
}

Organizations

Operations for organizations.

getOrgs

Get the organizations that the authenticated user has access.

Authorizations:
api_key
query Parameters
page_index
integer <uint32>
Default: 1

The page number to request. The first page is 1.

page_size
integer <uint32>
Default: 10

The number of items at most which the response can have.

Responses

200

List of the organizations which authenticated user has access.

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 /organizations
https://http-api-stoplight.cycloid.io/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "pagination":
    {
    }
}

createOrg

Create a new organization, making the authenticated user the owner of it.

Authorizations:
api_key
Request Body schema: application/vnd.cycloid.io.v1+json

The information of the organization to create.

canonical
required
string [ 3 .. 30 ] characters ^[a-z]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string >= 3 characters

Responses

200

Organization created. The body contains the information of the new created organization.

411

The request has a body but it doesn't have a Content-Length header.

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.

post /organizations
https://http-api-stoplight.cycloid.io/organizations

Request samples

Content type
application/vnd.cycloid.io.v1+json
Copy
 Expand all Collapse all
{
  • "canonical": "string",
  • "name": "string"
}

Response samples

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

getOrg

Get the information of the organization.

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

A canonical of an organization.

Responses

200

The information of the organization which has the specified ID.

403

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

404

The response sent when any of the entities present in the path is not found.

default

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

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

Response samples

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

deleteOrg

Delete the organization.

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

A canonical of an organization.

Responses

204

Organization has been deleted.

403

The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.

404

The response sent when any of the entities present in the path is not found.

default

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

delete /organizations/{organization_canonical}