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.

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

200
422
default

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"status": "KO",
"message": "some services returned an unknown state (s1), while some other returned errors (s2, s3)",
"checks": 
[
{"canonical": "s0",
"category": "internal",
"status": "Success",
"message": "no issue reported while connecting to s0"
},
{"canonical": "s1",
"category": "internal",
"status": "Unknown",
"message": "unknown state for s1 service"
},
{"canonical": "s2",
"category": "internal",
"status": "Error",
"message": "issue detected while connecting to s2"
},
{"canonical": "s3",
"category": "internal",
"status": "Success",
"message": "issue detected while connecting to s3"
}
]
}
}

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

200
422
default

Content type

application/json

Copy

Expand all Collapse all


{"data": 
{"version": "1.0.0",
"branch": "master",
"revision": "9d3d4d97"
}
}

Organizations

Operations for organizations.

getOrgAncestors

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

Authorizations:

api_key

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

200
401
default

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"canonical": "org1",
"id": 1,
"name": "Organization 1",
"ci_team_name": "asfdOPNljk",
"created_at": 1503225026,
"updated_at": 1503335026
},
{"canonical": "org2",