API docs by Redocly

Welcome! (0)

Download OpenAPI specification:

The Great Owl: contact@cycloid.io URL: https://www.cycloid.io License: Cycloid @copyrights Terms of Service

This is the Cycloid's API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types available within our console.

Cycloid

Operation related to Cycloid's application.

getEventsActionsAndEntities

Get the Cycloid possible actions and entities for the events

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getConfig

Get the Cycloid configuration.

Responses

Response samples

Content type
application/json
{}

getCountries

Get the Cycloid supported countries.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getHealthCheck

Returns the health status of internal services as Prometheus-formatted metrics. Each service is represented by a gauge with value 1 (up) or 0 (down).

Responses

Response samples

Content type
application/json
"# HELP service_xyz_status Status of service XYZ\n# TYPE service_xyz_status gauge\nservice_xyz_status 1\nservice_abc_status 0\n"

getMetrics

Exposes process, runtime, and application metrics in Prometheus text exposition format. Metrics are collected from the Prometheus registry.

Responses

Response samples

Content type
application/json
"# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use\n# TYPE go_memstats_alloc_bytes gauge\ngo_memstats_alloc_bytes 6.51536e+06\n# HELP http_requests_total The total number of HTTP requests\n# TYPE http_requests_total counter\nhttp_requests_total{method=\"get\",code=\"200\"} 1027\n"

getStatus

Get the status of the Cycloid's services.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getServiceStatus

Get the status of the Cycloid's service. It uses 200 and 500 to also identify the status

path Parameters
service_status_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of the service you want to get the status from

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getAppVersion

Get the version of the Cycloid's API.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organizations

Operations for organizations.

getEvents

Retrieve the list of events which has been registered on the organization. The events to request can be filtered using Unix timestamps in milliseconds (begin and end timestamps range), the event type and severity; when more than one are applied then they are applied with a logical AND.

  • The Unix timestamps must always be specified, the rest of the filters are not mandatory.
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

type
Array of strings
Items Enum: "Cycloid" "AWS" "Monitoring" "Custom"

Specify the types of the events to be requested. The returned events must have one of the specified types.

severity
Array of strings
Items Enum: "info" "warn" "err" "crit"

Specify the severities of the events to be requested. The returned events must have one of the specified severities.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

sendEvent

Send a event on the organization to be registered.

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

A canonical of an organization.

Request Body schema:
required

The information associated with the event to register.

type
required
string
Enum: "Cycloid" "AWS" "Monitoring" "Custom"

The type of the event

title
required
string non-empty

The title of the event.

message
required
string non-empty

The message associated to the event.

icon
string >= 3 characters
severity
required
string
Enum: "info" "warn" "err" "crit"

tThe severity associated to the event.

required
Array of objects (Key and value pair)

The list of tags associated to the event.

color
string [ 3 .. 20 ] characters [a-z]+

The HTML color associated to the event. The valid colors are the ones listed in the CSS 2 specification: https://www.w3.org/TR/CSS2/syndata.html#value-def-color. Only the keyword are accepted, the hexadecimal values are not valid.

Responses

Request samples

Content type
{
  • "type": "Cycloid",
  • "title": "string",
  • "message": "string",
  • "icon": "string",
  • "severity": "info",
  • "tags": [
    ],
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getEventsCount

Retrieve a count of events for given parameters

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

A canonical of an organization.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

events_count_granularity
required
string
Enum: "month" "week" "day"

Sets the events count granularity, it can be month, week, day.

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getEventsTags

Retrieve the list of tags and set of values for all the events of the organization.

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

A canonical of an organization.

query Parameters
project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getAncestors

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

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRepoBranches

Return all the branches of repository. If the repository is empty then an empty list will be returned.

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

A canonical of an organization.

query Parameters
credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

git_url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...

Git URL to repository

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

canDo

Checks if the JWT can do the action

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

A canonical of an organization.

Request Body schema:
required

The information of the authorization

action
required
string
entity_canonicals
required
Array of strings

List of the canonicals to the Resource excluding the Organization

Responses

Request samples

Content type
{
  • "action": "string",
  • "entity_canonicals": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrgs

Get the organizations that the authenticated user has access.

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

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

page_size
integer <uint32>
Default: 100

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

organization_name
string

Search by the organization's name

organization_created_at
integer <uint64>

Search by organization's creation date

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createOrg

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

Authorizations:
api_keyapi_key_query
Request Body schema:
required

The information of the organization to create.

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

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get the organization messages

Returns the messages associated to the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update the organization messages

Updates the messages associated to the organization.

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

A canonical of an organization.

Request Body schema:
required
creation_restricted_message
string or null

Responses

Request samples

Content type
{
  • "creation_restricted_message": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrg

Get the information of the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteOrg

Delete the organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateOrg

Update the information of the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization to update.

name
required
string >= 3 characters
quotas
boolean
can_children_create_appearance
boolean
can_children_use_dedicated_authentication
boolean
is_using_dedicated_authentication
boolean
sso_invite_only
boolean or null

When true, SSO users can only join the organization if they have been explicitly invited

mfa_enabled
boolean
creation_restricted_message
string or null

Message displayed to users when organization creation is restricted

Responses

Request samples

Content type
{
  • "name": "string",
  • "quotas": true,
  • "can_children_create_appearance": true,
  • "can_children_use_dedicated_authentication": true,
  • "is_using_dedicated_authentication": true,
  • "sso_invite_only": true,
  • "mfa_enabled": true,
  • "creation_restricted_message": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getSummary

Get the summary of the organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization teams

Operations for teams which belong to an organization.

getTeams

Get list of teams of the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

team_name
string

Search by team's name

team_created_at
integer <uint64>

Search by team's creation date

team_description
string

Search by team's description

member_id
integer <uint32>

Search by entity's owner

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createTeam

Create a new team in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the team to create.

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

User canonical that owns this team. If omitted then the person creating this team will be assigned as owner. When a user is the owner of a team it has all the permissions on it.

roles_canonical
required
Array of strings[ items [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$ ]

The roles to be assigned to a team.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "owner": "string",
  • "roles_canonical": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getTeam

Get the information of a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteTeam

Delete a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateTeam

Update the information of a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Request Body schema:
required

The information of the team to update.

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

User canonical that owns this team. Only the owner or an organization admin can update this field. When a user is the owner of a team it has all the permission on it.

roles_canonical
required
Array of strings[ items [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$ ]

The roles to be re-assigned to a team.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "owner": "string",
  • "roles_canonical": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization projects

Operations for projects which belong to an organization.

getProjects

Get list of projects of the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

project_name
string

Search by project's name

project_created_at
integer <uint64>

Search by project's creation date

project_description
string

Search by project's description

project_config_repository_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Search by project's config repository's canonical

service_catalog_source_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

member_id
integer <uint32>

Search by entity's owner

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

favorite
boolean

Flag to retrieve favorite data from the members favorite list.

environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createProject

Create a new project with pipelines in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the project to create.

canonical
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
name
required
string non-empty
description
string

A description regarding the project to help identify/remember details, implementation, purpose, etc.

owner
string

User canonical that owns this project. If omitted then the person creating this project will be assigned as owner. When a user is the owner of a project it has all the permissions on it.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
team_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Is only required when the using Quotas, it'll link the Project to the Team

color
string <= 64 characters
icon
string <= 64 characters

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "config_repository_canonical": "string",
  • "team_canonical": "string",
  • "color": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getProjectEnvironments

Get all the environments of the project

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createEnvironment

Create a new environment with provider, icon and color in a project

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Request Body schema:
required

The canonical of the environment to create and its configuration.

canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
name
required
string [ 1 .. 100 ] characters
color
string <= 64 characters

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteEnvironment

Delete a project environment.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

query Parameters
ignore_config_files_err
boolean

Defines if the error in config files operation (such as their removal) will be ignored instead of throwing an error and stopping the request

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateEnvironment

Update a project environment of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The canonical of the environment to update and its configuration.

name
required
string [ 1 .. 100 ] characters
color
string <= 64 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getEnvironment

Get a project environment of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createProjectFavorite

Add a new project in the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deleteProjectFavorite

Remove a project from the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getProject

Get a project of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteProject

Delete a project of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

query Parameters
ignore_config_files_err
boolean

Defines if the error in config files operation (such as their removal) will be ignored instead of throwing an error and stopping the request

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateProject

Update the information of a project of the organization. If the project has some information on the fields which aren't required and they are not sent or set to their default values, which depend of their types, the information will be removed.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Request Body schema:
required

The information of the project to update.

name
required
string non-empty
description
string
owner
string

User canonical that owns this project. Only the owner or an organization admin can update such a field. When a user is the owner of a project it has all the permission on it.

cloud_provider
string
Enum: "aws" "google" "azurerm" "flexibleengine" "openstack"

The cloud provider canonical that this project is using - between the supported ones.

config_repository_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The config_repository_canonical points to new Config Repository the project will be using. If this value is filled and it's different from the current one, the whole project will be migrated to new CR, meaning configuration files will also be moved. If the project didn't have config_repository_canonical set, this action will only attach the project to the CR, it won't create/move any files. In order to be sure everything works, make sure the config_repository_canonical is pointing at the CR with the same git repository that was used during project creation. Although the config_repository_canonical is not marked as required, it's actually required for projects that are already using CR. This field not being required is only for compatibility with older projects, which are not having CR yet.

color
string <= 64 characters
icon
string <= 64 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "cloud_provider": "aws",
  • "config_repository_canonical": "string",
  • "color": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization members

Operations for members of an organization.

getOrgMembers

Get the members of an organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

invitation_state
string
Enum: "accepted" "pending" "declined"

Search by Invitation's state

user_full_name
string

Search by the user's full name

role_name
string

Search by the role's name

user_canonical
string

Search by the user canonical

user_created_at
integer <uint64>

Search by user creation date

member_created_at
integer <uint64>

Search by member joining date

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

inviteUserToOrgMember

Invite a user to be a member of the organization.

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

A canonical of an organization.

Request Body schema:
required

The user's member invitation.

email
required
string <email>

Invite user by email

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The role of the member.

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "role_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrgMember

Get the information of a member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateOrgMember

Update member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Request Body schema:
required

The member information to be updated.

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The role of the member.

Responses

Request samples

Content type
{
  • "role_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

removeOrgMember

Remove a member of the organization.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

resendMemberInvitation

Resend the email containing the verification token to accept the member Invitation.

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

A canonical of an organization.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getPendingMemberInvitation

Get the email address used for the pending member invitation

path Parameters
verification_token
required
string >= 5 characters

A token for verifying emails, invitations, etc.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

User

Operations for the authenticated user.

emailVerificationResend

Re-send the verification user's email to the indicated address.

Request Body schema:
required

The email address to re-send the verification email. This endpoint doesn't return any error status code if the email doesn't exist nor it's already verified for avoiding that an attacker could find registered users email address.

email
required
string <email>

Responses

Request samples

Content type
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

emailVerification

Verify that the email address is own by the user.

path Parameters
verification_token
required
string >= 5 characters

A token for verifying emails, invitations, etc.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

emailAuthenticationVerification

Verify that the email address is own by the user.

path Parameters
authentication_token
required
string >= 5 characters

A token for authenticating login vie email

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateUserGuide

Update user's guide progress.

Request Body schema:

The guide's progress JSON schema

object (User guide JSON schema)

The user's guide progress JSON schema

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

login

Authenticate a user and return a new JWT token.

Request Body schema:
required

The user content

email
required
string <email>
password
required
string <password> >= 8 characters
organization_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "password": "pa$$word",
  • "organization_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

loginToOrg

Authenticate a user and return a new JWT token.

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

A canonical of an organization.

Request Body schema:
required

The user content

email
required
string <email>
password
required
string <password> >= 8 characters
organization_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "password": "pa$$word",
  • "organization_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateNotificationSettings

A user's notification settings.

Request Body schema:
required

Desired notification settings

watch_projects_on_create
required
boolean

Automatically subscribe to the project updates when creating a new project.

activity_report_frequency
required
string
Enum: "none" "daily" "weekly"

The frequency of the activity report.

Responses

Request samples

Content type
{
  • "watch_projects_on_create": true,
  • "activity_report_frequency": "none"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getNotificationSettings

Get the notification settings for the user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

markNotificationAsRead

Mark the notification as read for the user.

path Parameters
notification_id
required
integer <uint32>

Notification ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

markNotificationAsUnread

Mark the notification as unread for the user.

path Parameters
notification_id
required
integer <uint32>

Notification ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

markAllNotificationAsRead

Mark the all notification as read for the user.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getNotification

Get the notification for the user.

path Parameters
notification_id
required
integer <uint32>

Notification ID

Responses

Response samples

Content type
application/json
{
  • "id": 42,
  • "created_at": 1503225026,
  • "updated_at": 1503335026,
  • "read_at": 1503340000,
  • "watch_rule_canonical": "watch-my-project",
  • "event": {
    }
}

deleteNotification

Delete the notification for the user.

path Parameters
notification_id
required
integer <uint32>

Notification ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listNotifications

List all the notifications for the user.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

deleteAllNotifications

Delete all the notifications for the user at once.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getOAuthUser

Used to know if a user from the platform exists on that 'social_type'. If it exists we'll return the JWT 'token', if it does not we'll return the data of that user on the 'user' so it can be confirmed and created

path Parameters
social_type
required
string
Enum: "azuread" "saml2" "google" "github" "oidc"

The OAuth Social type

query Parameters
oauth_code
required
string

The OAuth code returned form the Social Provider

organization_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a organization used for filtering.

code_verifier
string

The PKCE code_verifier used for OAuth 2.0 PKCE flow

Responses

Response samples

Content type
application/json
{}

createOAuthUser

Create a user from the OAuth 'social_type'

path Parameters
social_type
required
string
Enum: "azuread" "saml2" "google" "github" "oidc"

The OAuth Social type

Request Body schema:
required

The user content

full_name
required
string [ 2 .. 255 ] characters
email
required
string <email>
username
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
picture_url
string <uri>
social_id
required
string
organization_canonical
string
invitation_token
string >= 5 characters

The field is used when a user signup from an invitation to an organization. Giving the token, the created user will be automatically added to the organization.

country_code
string^[A-Z]{2}$

Code of a country the user is from in alpha-2 format

locale
string
Enum: "en" "fr" "es"

User's preferred language

email_verified
boolean

User's email has been verified

Responses

Request samples

Content type
{
  • "full_name": "string",
  • "email": "user@example.com",
  • "username": "string",
  • "picture_url": "http://example.com",
  • "social_id": "string",
  • "organization_canonical": "string",
  • "invitation_token": "string",
  • "country_code": "string",
  • "locale": "en",
  • "email_verified": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

refreshToken

Refresh the user JWT and returns a new one if the previous is valid. The 'organization_canonical_query' has to be of an organization in which the user belongs to, and the 'child_canonical_query' of a child of the 'organization_canonical_query' in any level (could be of a grand child).

Authorizations:
api_keyapi_key_query
query Parameters
organization_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a organization used for filtering.

child_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a child organization used for filtering.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

passwordResetReq

Request to reset the password. Due to security reasons, this endpoint doesn't return Not Found (404) when the email doesn't exist or belongs to a user primary email.

Request Body schema:
required

The reset password payload

email
required
string <email>

the email address must be the primary email of the user.

Responses

Request samples

Content type
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

passwordResetUpdate

Reset the user password when it has been forgotten. Due to security reasons, the endpoint doesn't return a Unprocessable Entity (422) when the token is invalid. 404 Status code is returned if the user has been deleted of the system between the user password request and this request.

Request Body schema:
required

The reset password payload

password
required
string <password> >= 12 characters
token
required
string non-empty

Responses

Request samples

Content type
{
  • "password": "pa$$word_qwe",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getUserAccount

Get the information of the account of the authenticated user.

Authorizations:
api_keyapi_key_query

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateUserAccount

Update the information of the account of the authenticated user.

Authorizations:
api_keyapi_key_query
Request Body schema:
required

The user content

Array of objects (User's email) non-empty
object

The update password requires to confirm the old password.

username
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Used to identify the user. Not editable.

full_name
required
string [ 2 .. 255 ] characters
picture_url
string <uri>
country_code
string^[A-Z]{2}$

Code of a country the user is from in alpha-2 format

locale
required
string
Enum: "en" "fr" "es"

User's preferred language

mfa_enabled
required
boolean

Responses

Request samples

Content type
{
  • "emails": [
    ],
  • "password_update": {
    },
  • "username": "string",
  • "full_name": "string",
  • "picture_url": "http://example.com",
  • "country_code": "string",
  • "locale": "en",
  • "mfa_enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

signUp

Create a new User (sign-up).

Request Body schema:
required

The user content

invitation_token
string >= 5 characters

The field is used when a user signup from an invitation to an organization. Giving the token, the created user will be automatically added to the organization.

username
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
email
required
string <email>
password
required
string <password> >= 12 characters
full_name
required
string [ 2 .. 255 ] characters
country_code
string^[A-Z]{2}$

Alpha-2 country code of a country the user is from

locale
string
Enum: "en" "fr" "es"

User's preferred language

Responses

Request samples

Content type
{
  • "invitation_token": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "password": "pa$$word_qwe",
  • "full_name": "string",
  • "country_code": "string",
  • "locale": "en"
}

Response samples

Content type
application/json
{
  • "verified": false
}

deleteUserAccount

The authenticated user delete itself from the system.

Authorizations:
api_keyapi_key_query

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

handleAWSMarketplaceUserEntitlement

This endpoint handles redirections from AWS Marketplace to our system. If user doesn't exist, he'll be redirected to registration page. If user exist, he'll be redirected to login page.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

signUpAWSMarketplace

Create a new AWS Marketplace User.

Request Body schema:
required

The user content

aws_marketplace_token
required
string non-empty

The AWS marketplace token

username
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
email
required
string <email>
password
required
string <password> >= 12 characters
full_name
required
string [ 2 .. 255 ] characters
country_code
string^[A-Z]{2}$

Code of a country the user is from in alpha-2 format

locale
string
Enum: "en" "fr" "es"

User's preferred language

Responses

Request samples

Content type
{
  • "aws_marketplace_token": "string",
  • "username": "string",
  • "email": "user@example.com",
  • "password": "pa$$word_qwe",
  • "full_name": "string",
  • "country_code": "string",
  • "locale": "en"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

createWatchRule

Create a new watch rule for the user.

Request Body schema:
required
name
required
string >= 3 characters
required
Array of objects (New Watch rule filter) non-empty
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
project_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

Responses

Request samples

Content type
{
  • "name": "string",
  • "filters": [
    ],
  • "canonical": "string",
  • "organization_canonical": "string",
  • "project_canonical": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listWatchRules

List all the watch rules for the user.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

updateWatchRule

Update the watch rule for the user.

path Parameters
watch_rule_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a watch rule.

Request Body schema:
required
name
required
string >= 3 characters
Array of objects (New Watch rule filter)
muted
required
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "filters": [
    ],
  • "muted": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deleteWatchRule

Delete the watch rule for the user.

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

A canonical of a watch rule.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getWatchRule

Get the watch rule for the user.

path Parameters
watch_rule_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a watch rule.

Responses

Response samples

Content type
application/json
{
  • "canonical": "watch-my-project",
  • "created_at": 1503225026,
  • "updated_at": 1503335026,
  • "project_canonical": "my-project",
  • "actions": [
    ],
  • "entities": [
    ]
}

Organization Infrastructure

Operations on the infrastructure of an organization

getRunningInfraAWSBuckets Deprecated

Get the list of S3 buckets of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getRunningInfraAWS Deprecated

Get the number of resources classified by types, of the running AWS infrastructure of the organization and associated AWS account (credential). The parameters allow to select the scope of the request to one project of the organization and/or a set of type of resource.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

resource
Array of strings unique
Items Enum: "instances" "vpcs" "images" "security_groups" "subnets" "volumes" "snapshots" "cache_clusters" "load_balancers_v1" "load_balancers_v2" "db_instances" "buckets"

Supported AWS type of resource to query. The parameter can be specified several times in order to request for different kind of resources.

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getRunningInfraAWSDBInstances Deprecated

Get the list of RDS DB instances of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSElasticacheClusters Deprecated

Get the list of Elasticache clusters of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSImages Deprecated

Get the list of images of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getRunningInfraAWSInstances Deprecated

Get the list of instances of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSLoadBalancersV1 Deprecated

Get the list of load balancers (ELB) of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSLoadBalancersV2 Deprecated

Get the list of load balancers (ELB v2 or a.k.a ALB) of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSSecurityGroups Deprecated

Get the list of security groups of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSSnapshots Deprecated

Get the list of snapshots of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSSubnets Deprecated

Get the list of subnets of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getRunningInfraAWSVolumes Deprecated

Get the list of volumes of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

page_size
integer <uint32>
Default: 100

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

next
string non-empty

The token to retrieve the next page of results

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getRunningInfraAWSVPCs Deprecated

Get the list of VPCs of the running AWS infrastructure and associated with the AWS account (credential). The parameters allow to select the scope of the request to one project of the organization.

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

tag
Array of strings unique [ items [ 2 .. 383 ] characters ^(?:(?:[\w\-+=.:/@ ]+\|)|(?:\|[\w\-+=.:/@ ]+)... ]

An amazon tag, represented as key|value and where key or value could be omitted but not both, in order to select resources which has a key or a value whatever is its counterpart. key nor value can contains the | character. The parameter can be specified several times in order to request resources which match with at least one of the tag|value pairs

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Organization Environments

Operations to perform on an environment associated to a project of an organization.

getOrganizationEnvironments

Get all the environments of the Organization

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization Logs

Operations on the logs of a project

getProjEnvLogSources

Get the list of sources configured for the specified project's environment of the organization.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getProjEnvLogEntries

Get log's entries information of the specified log stream stream which is associated to the project's environment of the specified organization. The log's entries to request can be filtered using the unix timestamp ranges and/or the query as follow - When unix timestamps are defined, they are converted to the specific query language used by the configured underlying log system (e.g AWS Cloud Watch, ElasticSearch, etc.) and appended to the query value respecting the syntax but not checking the content of the query, which means that if the whole query must be enclosed by curly brackets hence the query value is enclosed on them, the time range filter will be added inside not just appended at the end, because otherwise it would cause wrong syntax; on the other hand, not checking the content means that if the query contains a timerange filter, the whole query will contain both and the result will be the one returned by on the underlying log system, being an error or not.

  • When no time range are defined, then the query is used as it has been send, there is not modification on the query to send to the underlying log system, hence the result will be the one returned by it.
  • If none of the filters (timestamp range and query) are sent, then a 422 status code will be responded.
  • Some constraints are established by the underlying log system, so depending which one has been configured some parameters may be required or not.
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

log_source_id
required
string non-empty

A unique identifier, which group log's entries under under a context, established by the source.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

query
string non-empty

A free text which the content depends of the context of the API endpoint. Can be a free text value or a complete query expressed of supported query language.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Organization Children

Operations on the children of an organization

getChildren

Get the children organizations that the authenticated user has access.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

organization_name
string

Search by the organization's name

organization_created_at
string <date-time>

Search by organization's creation date

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createChild

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

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

A canonical of an organization.

Request Body schema:
required

The information of the organization to create.

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

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Infrastructure Policies

Operations on the infrastructure policies of an organization

getInfraPolicies

Return a list of infrastructure policies which matches the scope specified by the filter.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

infra_policy_name
string

Search by InfraPolicy's name

infra_policy_created_at
integer <uint64>

Search by InfraPolicy's creation date

infra_policy_severity
string
Enum: "critical" "warning" "advisory"

Search by InfraPolicy's severity

infra_policy_enabled
boolean

Search by InfraPolicy's enabled

infra_policy_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Search by infra policy canonical

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createInfraPolicy

Create a new policy.

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

A canonical of an organization.

Request Body schema:
required
name
required
string >= 3 characters
description
string
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
owner
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

User canonical that owns this InfraPolicy. When a user is the owner of an InfraPolicy it has all the permissions on it.

body
required
string

The body field is the code in plain text that defines the rules for the policy.

severity
required
string
Enum: "critical" "warning" "advisory"
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "canonical": "string",
  • "owner": "string",
  • "body": "string",
  • "severity": "critical",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getInfraPolicy

Get the information of the InfraPolicy.

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

A canonical of an organization.

infra_policy_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an InfraPolicy.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteInfraPolicy

Delete the InfraPolicy.

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

A canonical of an organization.

infra_policy_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an InfraPolicy.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateInfraPolicy

Update an existing InfraPolicy

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

A canonical of an organization.

infra_policy_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an InfraPolicy.

Request Body schema:
required

The information of the organization to update.

name
required
string >= 3 characters
description
required
string
owner
required
string <= 100 characters

User canonical that owns this InfraPolicy. When a user is the owner of an InfraPolicy it has all the permissions on it. In the event where the Owner has been deleted then a new one can be assigned or an empty canonical is allowed to not reset it.

body
required
string

The body field is the code in plain text that defines the rules for the policy.

severity
required
string
Enum: "critical" "warning" "advisory"
enabled
required
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "owner": "string",
  • "body": "string",
  • "severity": "critical",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

validateProjectInfraPolicies

Check the InfraPolicies assigned to the Project and the Environment to identify if some are not respected.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The project's attributes to check before to apply an infrastructure change.

tfplan
required
string

Terraform plan file in escaped JSON format. See more: https://www.terraform.io/internals/json-format

Responses

Request samples

Content type
{
  • "tfplan": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Subscriptions

Operations on the subscriptions

getSubscription

Get the subscription for the Organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createSubscription

Creates a subscription for the Organization

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

A canonical of an organization.

Request Body schema:
required

The information of the subscription to create

plan_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "plan_canonical": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

createOrUpdateSubscription

Create or update the subscription for the Organization. This operation is idempotent.

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

A canonical of an organization.

Request Body schema:
required

The subscription information to create or update

expires_at
string <date-time>

The expiration date of the subscription in RFC3339 format

members_count
integer <uint64> >= 1

The maximum number of members allowed by the subscription

plan_canonical
string
Enum: "free_trial" "platform_teams"

The canonical of the plan. If not provided, defaults to platform_teams which requires root organization privileges

overwrite
boolean

When true, allows overwriting an existing subscription. Required to update an existing subscription

Responses

Request samples

Content type
{
  • "expires_at": "2019-08-24T14:15:22Z",
  • "members_count": 1,
  • "plan_canonical": "free_trial",
  • "overwrite": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteSubscription

Delete the subscription for the Organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Cost Estimation

Operations related to estimating cost of infrastructure.

costEstimateTfPlan

Estimate costs of a Terraform plan in JSON format.

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

A canonical of an organization.

Request Body schema:
required
tfplan
required
string

Terraform plan file in escaped JSON format. See more: https://www.terraform.io/internals/json-format

Responses

Request samples

Content type
{
  • "tfplan": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

costEstimateForm

Estimates the Cost from the Form Input

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The information of the filled form for a new project environment.

service_catalog_ref
required
string

It's the ref of the Stack, like 'cycloidio:stack-magento'

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
use_case
required
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
service_catalog_source_version_id
integer <uint32> >= 1

Is the ID of the new SCS Version used

required
object (FormVariables)

Forms variables filled, the format to respect is as follows { "sectionX": { "group1": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionY": { "group2": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionZ": { "group3": { "key1": "value2" }, } } Keys being the variable name that you want to see substituted/defined, while the section and group are the one from the form's file.

Responses

Request samples

Content type
{
  • "service_catalog_ref": "string",
  • "component_canonical": "string",
  • "use_case": "string",
  • "service_catalog_source_version_id": 1,
  • "vars": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Project KPIs

Operations on KPIs of an organization

getKpis

Get the list of configured KPIs

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

query Parameters
environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

fetch_data
boolean

Flag to retrieve KPIs' data upon retrieving KPIs themselves

page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

favorite
boolean

Flag to retrieve favorite data from the members favorite list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createKpi

Save information about the KPI

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

query Parameters
environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

fetch_data
boolean

Flag to retrieve KPIs' data upon retrieving KPIs themselves

page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

favorite
boolean

Flag to retrieve favorite data from the members favorite list.

Request Body schema:
required

The information of the KPI

name
required
string >= 3 characters
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
type
required
string
Enum: "build_avg_time" "build_frequency" "build_history" "code_coverage" "time_to_release"
widget
required
string
Enum: "bars" "stackbars" "doughnut" "history" "line" "pie" "summary"
config
object

The config represent some extra parameters which are required for the configuration of certain KPIs. Please refer to the documentation for more details.

description
string
pipeline_name
string
job_name
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "type": "build_avg_time",
  • "widget": "bars",
  • "config": { },
  • "description": "string",
  • "pipeline_name": "string",
  • "job_name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

createKPIFavorite

Add a kpi in the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

kpi_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a kpi.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deleteKPIFavorite

Remove a kpi from the user favorites list.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

kpi_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a kpi.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getKpi

Get the KPI

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

kpi_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a kpi.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

fetch_data
boolean

Flag to retrieve KPIs' data upon retrieving KPIs themselves

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateKpi

Update a KPI

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

kpi_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a kpi.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

fetch_data
boolean

Flag to retrieve KPIs' data upon retrieving KPIs themselves

Request Body schema:
required

The information of the KPI new data

name
required
string >= 3 characters
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
type
required
string
Enum: "build_avg_time" "build_frequency" "build_history" "code_coverage" "time_to_release"
widget
required
string
Enum: "bars" "stackbars" "doughnut" "history" "line" "pie" "summary"
config
object

The config represent some extra parameters which are required for the configuration of certain KPIs. Please refer to the documentation for more details.

description
string
pipeline_name
string
job_name
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "type": "build_avg_time",
  • "widget": "bars",
  • "config": { },
  • "description": "string",
  • "pipeline_name": "string",
  • "job_name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteKpi

delete a KPI

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

kpi_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a kpi.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

fetch_data
boolean

Flag to retrieve KPIs' data upon retrieving KPIs themselves

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization KPIs

Operations on KPIs of an organization

getOrganizationKpis

Get the list of configured KPIs in this organization

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

A canonical of an organization.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

favorite
boolean

Flag to retrieve favorite data from the members favorite list.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Organization components

Operations on the components of an organization

getComponents

Fetch the components that are part of the environment

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createComponent

Create a new Component

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The information of the component to create.

name
required
string non-empty
canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
description
string
service_catalog_ref
required
string

It's the ref of the Stack, like 'cycloidio:stack-magento'

cloud_provider_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
service_catalog_source_version_id
integer <uint32> >= 1

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "description": "string",
  • "service_catalog_ref": "string",
  • "cloud_provider_canonical": "string",
  • "service_catalog_source_version_id": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

createAndConfigureComponent

Create and configure a new Component in one step

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The information of the component to create and configure.

name
required
string non-empty
canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
description
string
service_catalog_ref
string

It's the ref of the Stack, like 'cycloidio:stack-magento'

cloud_provider_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
object (FormVariables)

Forms variables filled, the format to respect is as follows { "sectionX": { "group1": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionY": { "group2": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionZ": { "group3": { "key1": "value2" }, } } Keys being the variable name that you want to see substituted/defined, while the section and group are the one from the form's file.

use_case
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
service_catalog_source_version_id
integer <uint32> >= 1

Is the ID of the new SCS Version used

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "description": "string",
  • "service_catalog_ref": "string",
  • "cloud_provider_canonical": "string",
  • "vars": {
    },
  • "use_case": "string",
  • "service_catalog_source_version_id": 1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getComponentConfig

Fetch the current component configuration variables.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

query Parameters
service_catalog_source_version_id
integer <uint32>

The ID of the SCS Version

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getComponentStackConfiguration

Get the configuration of the service catalog for a specific use case in component. If no use case is specified, all the use cases will be returned. If an use case is specified, only the configuration for that use case will be returned.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

query Parameters
use_case
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A use case of a stack to be selectd from the stack config

service_catalog_source_version_id
integer <uint32>

The ID of the SCS Version

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

configureComponent

Configure the component

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

query Parameters
use_case
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A use case of a stack to be selectd from the stack config

Request Body schema:
required

Configuration object for the component

object (FormVariables)

Forms variables filled, the format to respect is as follows { "sectionX": { "group1": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionY": { "group2": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionZ": { "group3": { "key1": "value2" }, } } Keys being the variable name that you want to see substituted/defined, while the section and group are the one from the form's file.

use_case
required
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
service_catalog_source_version_id
integer <uint32> >= 1

Is the ID of the new SCS Version used

Responses

Request samples

Content type
{
  • "vars": {
    },
  • "use_case": "string",
  • "service_catalog_source_version_id": 1
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getComponentInfrastructure

Get the infrastructure of the Component

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

migrateComponent

Migrate the component that's part of the environment

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Request Body schema:
required

Component object that needs to be migrated

destination_project_canonical
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
destination_environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
destination_component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:[\da-zA-Z\-._]+[\da-zA-Z]|[\da...
destination_component_name
string

Responses

Request samples

Content type
{
  • "destination_project_canonical": "string",
  • "destination_environment_canonical": "string",
  • "destination_component_canonical": "string",
  • "destination_component_name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getOrganizationComponents

Fetch the components within the organization

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

listComponentPlugins

Fetch the plugins of the component

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

updateComponentPluginRelation

Update the component plugin relation

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

plugin_id
required
integer <uint32>

A plugin id

Request Body schema:
required

Update the component plugin relation

relations
required
object

List of relations between a Plugin and a Component

enabled
required
boolean

If the Plugin is enabled for the Component

Responses

Request samples

Content type
{
  • "relations": { },
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listComponentPluginWidgets

Fetch the widgets of all enabled plugins for the component

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getComponentPluginWidgetData

Query the data for a Plugin Widget.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

widget_id
required
integer <uint32>

A widget id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getComponentPluginWidgetIframeProxy

Proxy a GET request to the plugin for a widget iframe.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

postComponentPluginWidgetIframeProxy

Proxy a POST request to the plugin for a widget iframe.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

putComponentPluginWidgetIframeProxy

Proxy a PUT request to the plugin for a widget iframe.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deleteComponentPluginWidgetIframeProxy

Proxy a DELETE request to the plugin for a widget iframe.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getComponent

Fetch the component that's part of the environment

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateComponent

Update the component that's part of the environment

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Request Body schema:
required

Component object that needs to be updated

name
required
string non-empty
description
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteComponent

Delete the component that's part of the environment

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

query Parameters
ignore_config_files_err
boolean

Defines if the error in config files operation (such as their removal) will be ignored instead of throwing an error and stopping the request

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Component pipelines

Operations on the pipelines of a component

createPipeline

Create a new pipeline

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

Request Body schema:
required

The configuration of the pipeline to create.

pipeline_name
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-._]+[a-z0-9]+$
passed_config
string
yaml_vars
string
check_credentials
boolean

Validate credentials manager variables in the pipeline config.

Responses

Request samples

Content type
{
  • "pipeline_name": "string",
  • "passed_config": "string",
  • "yaml_vars": "string",
  • "check_credentials": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getPipeline

Get the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePipeline

Delete the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update the configuration of the given pipeline name

Update the configuration of the given pipeline name. This endpoint operates in two modes:

  1. pipeline config refresh from git (remote),
  2. live config update. In 1. we use the configured vars to execute the current config template retrieved from git. Parameter passed_config is ignored. In 2. we use the passed_config as is to update the pipeline config. The passed_config is the new pipeline config - it's not templated again.
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Request Body schema:
required

The pipeline configuration

refresh_from_git
boolean
Default: false

If set to true, the new pipeline content and vars are retrieved from git and templated.

passed_config
string

Already templated 'final' pipeline config that is used to perform 'live updates'. What you pass here is what you get.

yaml_vars
string
check_credentials
boolean

Responses

Request samples

Content type
{
  • "refresh_from_git": false,
  • "passed_config": "string",
  • "yaml_vars": "string",
  • "check_credentials": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

The diff between the provided pipeline configuration (or current config stored on git) of the pipeline with the given name.

The diff between the provided pipeline configuration (or current config stored on git) of the pipeline with the given name. This endpoint operates in two modes:

  1. diff with pipeline config from git (remote),
  2. diff with the passed_config. In 1. we use the configured vars to execute the current config template retrieved from git. Parameter passed_config is ignored. In 2. we use the passed_config as is to update the pipeline config. The passed_config is the new pipeline config - it's not templated again.
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Request Body schema:
required

The pipeline configuration

refresh_from_git
boolean
Default: false

If set to true, the new pipeline content and vars are retrieved from git and templated.

passed_config
string

Already templated 'final' pipeline config that is used to perform 'live updates'. What you pass here is what you get.

yaml_vars
string
check_credentials
boolean

Responses

Request samples

Content type
{
  • "refresh_from_git": false,
  • "passed_config": "string",
  • "yaml_vars": "string",
  • "check_credentials": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

syncedPipeline

Will check if the pipeline from the database and the one specified in the stack are synced or not

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

unpausePipeline

Unpause a pipeline

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

renamePipeline

Rename a pipeline

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

query Parameters
pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

pausePipeline

Pause a pipeline

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getPipelineConfig

Get the YAML configuration of the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "data": "{\"resources\":[{\"name\":\"5m\",\"type\":\"time\",\"source\":{\"interval\":\"5m\"}}],\"jobs\":[{\"name\":\"job-hello-world\",\"public\":true,\"plan\":[{\"get\":\"5m\",\"trigger\":true},{\"task\":\"hello-world\",\"privileged\":true,\"config\":{\"platform\":\"linux\",\"image_resource\":{\"type\":\"docker-image\",\"source\":{\"repository\":\"busybox\"}},\"run\":{\"path\":\"echo\",\"args\":[\"hello world\"]}}}]}]}"
}

getPipelineVariables

Get the YAML variables of the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Component Pipelines Jobs

Operations on the jobs of a pipeline in a component

getJobs

Get the jobs of the pipeline that the authenticated user has access to.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

pauseJob

Pause a job

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getJob

Get the information of the job.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

clearTaskCache

Clear task cache

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

step_name
required
string [ 1 .. 150 ] characters

A step name from a job task

query Parameters
cache_path
string
Default: ""

The cache path to use as part of a clearTaskCache request

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

unpauseJob

Unpause a job

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Component Pipelines Jobs Builds

Operations on the builds of a job in a pipeline

abortBuild

Abort a specific build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getBuilds

Get the pipeline job's builds that the authenticated user has access to.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

query Parameters
concourse_page_since
integer <uint64>
Default: 0

The time after which we should look for entities to return.

concourse_page_until
integer <uint64>
Default: 0

The time before which we should look for entities to return.

concourse_page_limit
integer <uint64>
Default: 10

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination_concourse": {
    }
}

createBuild

Create a new build for the job

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getBuildEvents

Get the events of a build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getBuildPlan

Get the plan of the build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getBuildPreparation

Get the preparation of the Build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getBuild

Get the information of the build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

rerunBuild

Reruns a specific build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getBuildResources

Get the resources of the build.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

job_name
required
string [ 1 .. 150 ] characters

A job name

build_id
required
string [ 1 .. 20 ] characters ^[0-9]+$

A build id

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Component Pipeline Resources

Operations on the resources of a pipeline in a component

checkResource

Trigger a check for a specified resource.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

Request Body schema:

Check for new version from the specified version.

property name*
additional property
string

Responses

Request samples

Content type
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getPipelineResources

Get the resources of the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

resourceSetPinComment

Set pin comment on a specified resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

Request Body schema:
required

Specify the comment to put on a pinned resource.

pin_comment
required
string

Responses

Request samples

Content type
{
  • "pin_comment": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getResource

Get a specific resource of the pipeline.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

unpinResource

Unpin a specified resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Component Pipeline Resources Versions

Operations on the versions of a resource in a pipeline

getResourceVersions

Get versions of a pipeline's resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

query Parameters
filter_version
Array of strings non-empty

A version of a resource

concourse_page_since
integer <uint64>
Default: 0

The time after which we should look for entities to return.

concourse_page_until
integer <uint64>
Default: 0

The time before which we should look for entities to return.

concourse_page_limit
integer <uint64>
Default: 10

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination_concourse": {
    }
}

disableResourceVersion

Disable a specified version of a resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

resource_version_id
required
integer <uint64>

A resource's version id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

enableResourceVersion

Enable a specified version of a resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

resource_version_id
required
integer <uint64>

A resource's version id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getBuildsWithVersionAsInput

Get builds that used a specified resource version as input.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

resource_version_id
required
integer <uint64>

A resource's version id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getBuildsWithVersionAsOutput

Get builds that used a specified resource version as output.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

resource_version_id
required
integer <uint64>

A resource's version id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

pinResourceVersion

Pin a specified version of a resource

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

inpath_pipeline_name
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

resource_name
required
string [ 1 .. 150 ] characters

A resource name

resource_version_id
required
integer <uint64>

A resource's version id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Appearance

getActiveAppearance

Get the active appearance available in the organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{}

getDefaultAppearance

Get the default appearance available in the platform

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Authentications

listDefaultAuthentications

List of authentications available in the root organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listOrganizationDefaultAuthentications

List of authentications available in the root organization.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Code Generation

terraformJSONToHCL

Transforms a JSON to a HCL

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

A canonical of an organization.

Request Body schema:
required

The Terraform JSON config

config
required
object

Responses

Request samples

Content type
{
  • "config": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getInfraImportPresets

List Infra Import Presets

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getInfraImportResource

List Provider's Resource

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

resource_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Resource

Request Body schema:
required

Information for filtering and access the Cloud Provider's Resources.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Credential that will be used to import from the provider

required
object (CloudProviderConfiguration)
tags
Array of strings

Responses

Request samples

Content type
{
  • "credential_canonical": "string",
  • "configuration": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getInfraImportResources

List infrastructure import provider's resources

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

Request Body schema:
required

Access information of the Cloud Provider's Resources.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Credential that will be used to import from the provider

required
object (CloudProviderConfiguration)

Responses

Request samples

Content type
{
  • "credential_canonical": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getTerraformProviders

Return all the Providers

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{}

getTerraformProviderDataSources

Return all the DataSources for the Provider

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getTerraformProviderDataSource

Get the information of the DataSource

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

resource_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Resource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getTerraformProvider

Get the information of the Provider

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getTerraformProviderResources

Return all the Resources for the Provider

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getTerraformProviderResource

Get the information of the Resource

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

resource_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Resource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

terraformValidate

Validates a TF configuration

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

A canonical of an organization.

Request Body schema:
required

The Terraform JSON config

config
required
object

Responses

Request samples

Content type
{
  • "config": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization API keys

getAPIKeys

Get list of API keys of the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

member_id
integer <uint32>

Search by entity's owner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createAPIKey

Create a new API key in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the API key to create.

canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string >= 3 characters
description
string
required
Array of objects (NewRule)
owner
string

User canonical that owns this API key. If omitted then the person creating this credential will be assigned as owner. When a user is the owner of an API key he has all the permissions on it.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "description": "string",
  • "rules": [
    ],
  • "owner": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getAPIKey

Get an API key of the organization.

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

A canonical of an organization.

api_key_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an API key.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteAPIKey

Delete an API key of the organization.

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

A canonical of an organization.

api_key_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an API key.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateAPIkey

Update the information of an API key of the organization. If the API key has some information on the fields which aren't required and they are not sent or set to their default values, which depend of their types, the information will be removed.

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

A canonical of an organization.

api_key_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an API key.

Request Body schema:
required

The information of the API key to update.

name
required
string >= 3 characters
description
string
owner
string

User canonical that owns this API key. Only the owner or an organization admin can update such a field. When a user is the owner of a API key it has all the permission on it.

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "owner": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Appearances

listAppearances

List of appearances available in the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{}

createAppearance

Create a new appearance for the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization's appearance to create.

name
required
string [ 1 .. 50 ] characters
display_name
required
string [ 1 .. 50 ] characters
tab_title
required
string [ 1 .. 50 ] characters
required
object
logo
required
string <uri>
favicon
required
string <uri>
footer
required
string [ 0 .. 1000 ] characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "display_name": "string",
  • "tab_title": "string",
  • "color": {
    },
  • "logo": "http://example.com",
  • "favicon": "http://example.com",
  • "footer": "string"
}

Response samples

Content type
application/json
{}

getAppearance

Get the appearance available in the organization with a canonical

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

A canonical of an organization.

appearance_canonical
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an appearance.

Responses

Response samples

Content type
application/json
{}

updateAppearance

Update an existing appearance in the organization.

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

A canonical of an organization.

appearance_canonical
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an appearance.

Request Body schema:
required

The information of the organization's appearance to update.

canonical
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
required
string [ 1 .. 50 ] characters
display_name
required
string [ 1 .. 50 ] characters
tab_title
required
string [ 1 .. 50 ] characters
required
object
logo
required
string <uri>
favicon
required
string <uri>
footer
required
string [ 0 .. 1000 ] characters
is_active
boolean
created_at
integer <uint64> >= 0
updated_at
integer <uint64> >= 0

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "display_name": "string",
  • "tab_title": "string",
  • "color": {
    },
  • "logo": "http://example.com",
  • "favicon": "http://example.com",
  • "footer": "string",
  • "is_active": true,
  • "created_at": 0,
  • "updated_at": 0
}

Response samples

Content type
application/json
{}

deleteAppearance

Delete an existing appearance in the organization.

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

A canonical of an organization.

appearance_canonical
required
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an appearance.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization Authentications

listAuthentications

List of authentications available in the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getAuthentication

Get the authentication available in the organization with a canonical

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

A canonical of an organization.

authentication_type
required
string
Enum: "AuthenticationLocal" "AuthenticationSAML" "AuthenticationGitHub" "AuthenticationGoogle" "AuthenticationAzureAD" "AuthenticationOIDC"

The type of the Authentication

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateAuthentication

Update an existing authentication in the organization.

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

A canonical of an organization.

authentication_type
required
string
Enum: "AuthenticationLocal" "AuthenticationSAML" "AuthenticationGitHub" "AuthenticationGoogle" "AuthenticationAzureAD" "AuthenticationOIDC"

The type of the Authentication

Request Body schema:
required

The information of the organization's authentication to update.

object (AuthenticationConfig)

Responses

Request samples

Content type
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management Dashboard

getCloudCostManagementDashboard

Return the dashboard of the Cloud Cost Management. It contains one histogram per cloud provider, five top projects, the list of projects resources aggregated by cloud provider and the cost of the new resource in the period.

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

A canonical of an organization.

query Parameters
granularity
required
string
Enum: "month" "week" "day"

Sets the cost granularity, it can be month, week, day.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

currency
required
string
Enum: "USD" "EUR" "CNY" "GBP"

The currency required for the results.

projects
Array of strings

The names of the projects that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

record_types
Array of strings

The type of records that you can use to filter your results. For example usage or credit.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management filter vaules

getCloudCostManagementFilterVaules

Return a map with all the possible filter vaules

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

A canonical of an organization.

query Parameters
begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

projects
Array of strings

The names of the projects that you can use to filter your results

environments
Array of strings

The names of the environments that you can use to filter your results

components
Array of strings

The names of the components that you can use to filter your results

services
Array of strings

The names of the services that you can use to filter and group your results.

tags
Array of strings[ items [ 4 .. 127 ] characters ^[^;]+;[^;]+$ ]

The key and value of a tag concatenated by a ;.

categories
Array of strings
Items Enum: "other" "compute" "storage" "database" "dev_tools" "networking" "analytics" "containers" "machine_learning" "multimedia" "security"

The names of the categories that you can use to filter and group your results.

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

regions
Array of strings

The names of the regions that you can use to filter your results

resource_tagging
string
Enum: "tagged_resources" "untagged_resources"

Filter results by only tagged or not tagged resources

group_by
Array of strings unique
Items Enum: "environment" "service" "instance_type" "category" "location" "linked_account" "project" "record_type" "component"

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.

dashboard
boolean
Default: false

Specifies if the filter values are for the dashboard

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management Projects Dashboard

getCloudCostManagementProjectsDashboard

Return the projects dashboard of the Cloud Cost Management. It contains one date histogram with the aggregation by project, and a histogram with the aggregation by project and provider.

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

A canonical of an organization.

query Parameters
granularity
required
string
Enum: "month" "week" "day"

Sets the cost granularity, it can be month, week, day.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

currency
required
string
Enum: "USD" "EUR" "CNY" "GBP"

The currency required for the results.

projects
Array of strings

The names of the projects that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management Provider Histograms

getCloudCostManagementProvider

Return a histogram of the costs generated in a given period aggregated by time granularity and other terms, for a single provider.

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

query Parameters
granularity
required
string
Enum: "month" "week" "day"

Sets the cost granularity, it can be month, week, day.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

currency
required
string
Enum: "USD" "EUR" "CNY" "GBP"

The currency required for the results.

projects
Array of strings

The names of the projects that you can use to filter your results

environments
Array of strings

The names of the environments that you can use to filter your results

components
Array of strings

The names of the components that you can use to filter your results

services
Array of strings

The names of the services that you can use to filter and group your results.

tags
Array of strings[ items [ 4 .. 127 ] characters ^[^;]+;[^;]+$ ]

The key and value of a tag concatenated by a ;.

categories
Array of strings
Items Enum: "other" "compute" "storage" "database" "dev_tools" "networking" "analytics" "containers" "machine_learning" "multimedia" "security"

The names of the categories that you can use to filter and group your results.

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

regions
Array of strings

The names of the regions that you can use to filter your results

resource_tagging
string
Enum: "tagged_resources" "untagged_resources"

Filter results by only tagged or not tagged resources

group_by
Array of strings unique
Items Enum: "environment" "service" "instance_type" "category" "location" "linked_account" "project" "record_type" "component"

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.

record_types
Array of strings

The type of records that you can use to filter your results. For example usage or credit.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getCloudCostManagementProviders

Return a histogram of the costs generated in a given period aggregated by time granularity and other terms, for a single provider.

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

A canonical of an organization.

query Parameters
granularity
required
string
Enum: "month" "week" "day"

Sets the cost granularity, it can be month, week, day.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

currency
required
string
Enum: "USD" "EUR" "CNY" "GBP"

The currency required for the results.

projects
Array of strings

The names of the projects that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Organization Cloud Cost Management Provider Details

getCloudCostManagementProviderDetails

Return a histogram of the costs generated in a given period aggregated by time granularity and other terms, for a single provider.

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

A canonical of an organization.

provider_canonical
required
string >= 3 characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a Provider

query Parameters
granularity
required
string
Enum: "month" "week" "day"

Sets the cost granularity, it can be month, week, day.

begin
integer <uint64>

The unix timestamp in milliseconds, which indicate the start of the time range.

end
integer <uint64>

The unix timestamp in milliseconds, which indicate the end of the time range.

currency
required
string
Enum: "USD" "EUR" "CNY" "GBP"

The currency required for the results.

projects
Array of strings

The names of the projects that you can use to filter your results

environments
Array of strings

The names of the environments that you can use to filter your results

components
Array of strings

The names of the components that you can use to filter your results

services
Array of strings

The names of the services that you can use to filter and group your results.

tags
Array of strings[ items [ 4 .. 127 ] characters ^[^;]+;[^;]+$ ]

The key and value of a tag concatenated by a ;.

categories
Array of strings
Items Enum: "other" "compute" "storage" "database" "dev_tools" "networking" "analytics" "containers" "machine_learning" "multimedia" "security"

The names of the categories that you can use to filter and group your results.

master_accounts
Array of strings

The ids of the master accounts that you can use to filter your results

linked_accounts
Array of strings

The ids of the linked accounts that you can use to filter your results

regions
Array of strings

The names of the regions that you can use to filter your results

resource_tagging
string
Enum: "tagged_resources" "untagged_resources"

Filter results by only tagged or not tagged resources

group_by
Array of strings unique
Items Enum: "environment" "service" "instance_type" "category" "location" "linked_account" "project" "record_type" "component"

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.

record_types
Array of strings

The type of records that you can use to filter your results. For example usage or credit.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management

getCloudCostManagementTags

Return a list of tags used in Cloud Cost Management records.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Organization Cloud Cost Management Accounts

getCloudCostManagementAccounts

Return a list of Cloud Cost Management accounts which matches the scope specified by the filter.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

cloud_cost_management_account_created_at_query
integer <uint64>

Search by Cloud Cost Management account's creation date

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createCloudCostManagementAccount

Create a new Cloud Cost Management account.

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

A canonical of an organization.

Request Body schema:
required
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
string

A user-defined name for the account

required
object (New External backend)

An external backend contains the configuration needed in order to be plugged into the Cycloid system. A backend is a general purpose concept, but Cycloid specifies which ones are supported and the list of those which are supported for every concrete feature.

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "external_backend": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getCloudCostManagementAccountsHasParent

Return whether account under provided credentials is a child account

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

A canonical of an organization.

query Parameters
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createCloudCostManagementAccountChild

Create a new Cloud Cost Management account.

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

A canonical of an organization.

Request Body schema:
required
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
name
string

A user-defined name for the account

parent_account_id
required
string

The ID of the parent account on the CP

credential_canonical
required
string

Canonical of the credentials used

Responses

Request samples

Content type
{
  • "canonical": "string",
  • "name": "string",
  • "parent_account_id": "string",
  • "credential_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getCloudCostManagementLinkedAccounts

Return a list of cloud provider accounts linked to a specific Cloud Cost Management account.

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

A canonical of an organization.

cloud_cost_management_account_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an CloudCostManagementAccount.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

updateCloudCostManagementLinkedAccount

Update a Cloud Cost Management linked account

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

A canonical of an organization.

cloud_cost_management_account_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an CloudCostManagementAccount.

cloud_provider_account_id
required
string

The id of an account in the Cloud Provider.

Request Body schema:
required

The updated attributes of the Cloud Cost Management linked account

name
required
string

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 99,
  • "name": "Updated linked account name",
  • "account_id": "123456789",
  • "cloud_provider": "aws"
}

getCloudCostManagementAccount

Get the information of the CloudCostManagementAccount.

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

A canonical of an organization.

cloud_cost_management_account_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an CloudCostManagementAccount.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteCloudCostManagementAccount

Delete the CloudCostManagementAccount.

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

A canonical of an organization.

cloud_cost_management_account_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an CloudCostManagementAccount.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateCloudCostManagementAccount

Update an existing CloudCostManagementAccount

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

A canonical of an organization.

cloud_cost_management_account_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The canonical of an CloudCostManagementAccount.

Request Body schema:
required

The information of the organization to update.

enabled
required
boolean
name
string

A user-defined name for the account

required
object (Update External backend)

An external backend contains the configuration needed in order to be plugged into the Cycloid system. A backend is a general purpose concept, but Cycloid specifies which ones are supported and the list of those which are supported for every concrete feature.

Responses

Request samples

Content type
{
  • "enabled": true,
  • "name": "string",
  • "external_backend": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Cloud Cost Management Tag Mappings

getCloudCostManagementTagMapping

Return the Cloud Cost Management tag mapping for the organization

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

putCloudCostManagementTagMapping

Create or Update a Cloud Cost Management Tag Mapping.

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

A canonical of an organization.

Request Body schema:
required
project_tags
Array of strings
project_regex
string
environment_tags
Array of strings
environment_regex
string
component_regex
string
component_tags
Array of strings

Responses

Request samples

Content type
{
  • "project_tags": [
    ],
  • "project_regex": "string",
  • "environment_tags": [
    ],
  • "environment_regex": "string",
  • "component_regex": "string",
  • "component_tags": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cloud providers

getCloudProviders

Get the list of Cloud Providers

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization Config Repositories

listConfigRepositories

Return all the config repositories

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

default
boolean
Default: false

Value describing whether to return default

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createConfigRepository

Creates a config repository

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

A canonical of an organization.

Request Body schema:
required

The information of the config repository to create.

name
required
string
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...
branch
required
string
default
required
boolean
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "url": "string",
  • "branch": "string",
  • "default": true,
  • "credential_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

createConfigRepositoryConfig

Create Service Catalog config files in the Config Repository.

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

A canonical of an organization.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Config Repositories canonical

Request Body schema:
required

The body contains Service Catalog's config files and paths where they'll be created in the Config Repository.

required
Array of objects (SC config file)

Config files that will be created

Responses

Request samples

Content type
{
  • "configs": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getConfigRepository

Return the Config Repository

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

A canonical of an organization.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Config Repositories canonical

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateConfigRepository

Update a config repository

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

A canonical of an organization.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Config Repositories canonical

Request Body schema:
required

The information of the config repository to create.

name
required
string
url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...
branch
required
string
default
required
boolean
credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Responses

Request samples

Content type
{
  • "name": "string",
  • "url": "string",
  • "branch": "string",
  • "default": true,
  • "credential_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteConfigRepository

delete a Config Repositories

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

A canonical of an organization.

config_repository_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Config Repositories canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization Credentials

listCredentials

Return all the Credentials, depending on the caller permissions it'll return the Raw data or not. If the caller has List and not Get it'll not return the Raw, if it has List and Read it'll return the Raw.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

credential_type
string
Enum: "ssh" "aws" "custom" "azure" "azure_storage" "gcp" "basic_auth" "elasticsearch" "swift"

Deprecated. Please use credential_types. A Credential type

credential_types
Array of strings unique
Items Enum: "ssh" "aws" "custom" "azure" "azure_storage" "gcp" "basic_auth" "elasticsearch" "swift"

Multiple Credential types

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createCredential

Create a new Credential, based on the type you will have to pass different parameters within the body:

  • ssh: ssh_key
  • aws: access_key, secret_key
  • gcp: json_key
  • azure: client_id, client_secret, subscription_id, tenant_id
  • azure_storage: account_name, access_key
  • basic_auth: username, password
  • elasticsearch: username, password, ca_cert
  • swift: auth_url, username, password, domain_id, tenant_id
  • vmware: username, password
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

Request Body schema:
required

The information of the organization to create.

name
required
string
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
type
required
string
Enum: "ssh" "aws" "custom" "azure" "azure_storage" "gcp" "basic_auth" "elasticsearch" "swift" "vmware"
path
required
string[a-zA-z0-9_\-./]
required
object (Credential Raw)

All the possible fields inside it

description
string
owner
string

User canonical that owns this credential. If omitted then the person creating this credential will be assigned as owner. When a user is the owner of a credential he has all the permissions on it.

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "type": "ssh",
  • "path": "string",
  • "raw": {
    },
  • "description": "string",
  • "owner": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getCredential

Get the information of the Credential.

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

A canonical of an organization.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteCredential

Delete the Credential.

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

A canonical of an organization.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateCredential

Update an existing Credential, based on the type you will have to pass different parameters within the body:

  • ssh: ssh_key
  • aws: access_key, secret_key
  • gcp: json_key
  • azure: client_id, client_secret, subscription_id, tenant_id
  • azure_storage: account_name, access_key
  • basic_auth: username, password
  • elasticsearch: username, password, ca_cert
  • swift: auth_url, username, password, domain_id, tenant_id
  • vmware: username, password
Authorizations:
api_keyapi_key_query
path Parameters
organization_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of an organization.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

Request Body schema:
required

The information of the organization to update.

name
required
string
canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
type
required
string
Enum: "ssh" "aws" "custom" "azure" "azure_storage" "gcp" "basic_auth" "elasticsearch" "vmware"
path
required
string[a-zA-z0-9_\-./]
required
object (Credential Raw)

All the possible fields inside it

description
string
owner
string

User canonical that owns this credential. When a user is the owner of a credential he has all the permissions on it.

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "type": "ssh",
  • "path": "string",
  • "raw": {
    },
  • "description": "string",
  • "owner": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getCredentialOptions

Get options of the Credential.

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

A canonical of an organization.

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A Credential canonical

query Parameters
service
required
string
Value: "gcp_bigquery"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization External Backends

getExternalBackends

Get the list of organization external backends

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

A canonical of an organization.

query Parameters
project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

external_backend_default
boolean

Filter for default Terraform External Backend

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createExternalBackend

Save information about the external backend

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

A canonical of an organization.

query Parameters
project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a component.

external_backend_default
boolean

Filter for default Terraform External Backend

Request Body schema:
required

The information of the external backend

purpose
required
string
Enum: "events" "logs" "remote_tfstate" "cost_explorer"
default
boolean

Will mark this EB as default for the specific purpose

credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The type of the credential must be one of: ["aws", "azure_storage", "elasticsearch", "gcp", "swift", "vmware"]

project_canonical
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
required
object (ExternalBackendConfiguration)

Responses

Request samples

Content type
{
  • "purpose": "events",
  • "default": true,
  • "credential_canonical": "string",
  • "project_canonical": "string",
  • "environment_canonical": "string",
  • "component_canonical": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getExternalBackend

Get the external backend

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

A canonical of an organization.

external_backend_id
required
integer <uint32>

External Backend ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateExternalBackend

Update an External Backend

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

A canonical of an organization.

external_backend_id
required
integer <uint32>

External Backend ID

Request Body schema:
required

The information of the external backend new data

id
integer <uint32> >= 1
purpose
required
string
Enum: "events" "logs" "remote_tfstate" "cost_explorer"
default
boolean

Will mark this EB as default for the specific purpose

credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The type of the credential must be one of: ["aws", "azure_storage", "elasticsearch", "gcp", "swift", "vmware"]

project_canonical
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
component_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
required
object (ExternalBackendConfiguration)

Responses

Request samples

Content type
{
  • "id": 1,
  • "purpose": "events",
  • "default": true,
  • "credential_canonical": "string",
  • "project_canonical": "string",
  • "environment_canonical": "string",
  • "component_canonical": "string",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteExternalBackend

delete an External Backend

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

A canonical of an organization.

external_backend_id
required
integer <uint32>

External Backend ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization Forms

interpolateFormsConfig

Generate a set of configs based on the forms input but without creating anything

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

Request Body schema:
required

The information of the filled forms for a new project environment. Warning: this endpoint isn't creating anything, it's just returning the configuration that would be created.

service_catalog_ref
required
string

It's the ref of the Stack, like 'cycloidio:stack-magento'

component_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...
component-name
string
use_case
required
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
service_catalog_source_version_id
integer <uint32> >= 1

Is the ID of the new SCS Version used

required
object (FormVariables)

Forms variables filled, the format to respect is as follows { "sectionX": { "group1": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionY": { "group2": { "key1": "value1", "key2": "value2", "key3": "value3" }, }, "sectionZ": { "group3": { "key1": "value2" }, } } Keys being the variable name that you want to see substituted/defined, while the section and group are the one from the form's file.

Responses

Request samples

Content type
{
  • "service_catalog_ref": "string",
  • "component_canonical": "string",
  • "component-name": "string",
  • "use_case": "string",
  • "service_catalog_source_version_id": 1,
  • "vars": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

validateFormsFile

Validate a forms file definition

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

A canonical of an organization.

Request Body schema:
required

The content of the forms file to be validated.

form_file
required
object

A form's file to any given version

Responses

Request samples

Content type
{
  • "form_file": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

valuesRefForms

Returns the values from the ref

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

A canonical of an organization.

Request Body schema:
required

The URL to fetch the values from

url
required
string

The url to which fetch the results

Responses

Request samples

Content type
{
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Infra Imports

createInfraImport

Create a new Infra Import

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

A canonical of an organization.

Request Body schema:
required

The information of the Infra Import to create

object

It's a KV where the key is the resource name and the value is the list (array) of attributes to include as part of the module

tags
Array of strings

List of tags to filter with format NAME:VALUE

include
Array of strings

List of resources to import, these names are the ones on TF (ex: aws_instance). If not set then it means that all the resources will be imported

targets
Array of strings

List of resources to import via ID, those IDs are the ones documented on Terraform that are needed to Import. The format is 'aws_instance.ID'

credential_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Credential that will be used to import from the provider

required
object (NewServiceCatalog)

Represents all information needed to create a new Service Catalog item

object (Create Project for the Infra Import)

The entity which represents the information of a new project.

object (NewEnvironment)

Represent an entity necessary for environment creation

object (Create Component for the Infra Import)

The entity which represents the information of a new component.

object (New External backend)

An external backend contains the configuration needed in order to be plugged into the Cycloid system. A backend is a general purpose concept, but Cycloid specifies which ones are supported and the list of those which are supported for every concrete feature.

required
object (CloudProviderConfiguration)

Responses

Request samples

Content type
{
  • "module_variables": {
    },
  • "tags": [
    ],
  • "include": [
    ],
  • "targets": [
    ],
  • "credential_canonical": "string",
  • "stack": {
    },
  • "project": {
    },
  • "environment": {
    },
  • "component": {
    },
  • "external_backend": {
    },
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getInfraImport

Get the Infra Import

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteInfraImport

Delete the infra Import.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

retryInfraImport

Retry infra import.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceCatalogImport

Get the import of a new Stack of the organization.

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteServiceCatalogImport

Delete the Stack import of the organization.

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

retryServiceCatalogImport

Retry to import a Stack.

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization Inventory

getState

Get the state

query Parameters
jwt
required
string

Token with the information about state and credentials.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

createOrUpdateState

Create or update an Inventory State

query Parameters
jwt
required
string

Token with the information about state and credentials.

Request Body schema: application/json
required

The information of the Inventory new data

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listInventoryResources

List the inventory resources

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "filters": {
    }
}

createInventoryResource

Create an Inventory Resource

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

A canonical of an organization.

Request Body schema:
required

The information of the Inventory new resource data

provider
required
string

The provider of the created Resource

type
required
string

The type of the resource

name
required
string

The name of the resource

custom_attributes
object

List of attributes (key value object) of the Resource, can be anything

label
required
string

A way to distinguish and categorize resources

memory
integer <uint64> >= 0

The amount of memory that it has in MB

cpu
integer <uint64> >= 0

The amount of cpu cores that it has in units

storage
integer <uint64> >= 0

The amount of storage that it has in MB

Responses

Request samples

Content type
{
  • "provider": "string",
  • "type": "string",
  • "name": "string",
  • "custom_attributes": {
    },
  • "label": "my-label",
  • "memory": 0,
  • "cpu": 0,
  • "storage": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listResourceTypes

List Resource Types

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

A canonical of an organization.

query Parameters
resources_provider
required
string

Provider of Inventory Resource

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listResourceLabels

List Resource Labels

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

lockState

Locks an Inventory State

query Parameters
jwt
required
string

Token with the information about state and credentials.

Request Body schema: application/json
required

The information of the Inventory new data

id
string
operation
string
info
string
who
string
version
string
created
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "operation": "string",
  • "info": "string",
  • "who": "string",
  • "version": "string",
  • "created": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

unlockState

unlocks an State of Inventory

query Parameters
jwt
required
string

Token with the information about state and credentials.

Request Body schema: application/json
required

The information of the Inventory new data

id
string
operation
string
info
string
who
string
version
string
created
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "operation": "string",
  • "info": "string",
  • "who": "string",
  • "version": "string",
  • "created": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listInventoryOutputs

List the outputs of terraform states of an organization. Can be filtered by: * output_key * output_attribute * project_canonical * environment_canonical * component_canonical * service_catalog_canonical

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

order_by
string

Allows to order the list of items. Example usage: field_name:asc. Multiple order_by parameters are allowed, applied in the order they are specified.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "filters": {
    }
}

pinInventoryOutput

-| Pin an Inventory Output (a terraform state output). Pinning the output will highlight it on the frontend.

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

A canonical of an organization.

inventory_output_id
required
integer <uint32>

ID of an inventory output (terraform state output)

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

unpinInventoryOutput

-| Unpin an Inventory Output (a terraform state output). Unpinning the output will prevent it from being highlighted on the frontend.

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

A canonical of an organization.

inventory_output_id
required
integer <uint32>

ID of an inventory output (terraform state output)

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getInventoryResource

Get the inventory resource by the ID

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

A canonical of an organization.

inventory_resource_id
required
integer <uint32>

Inventory Resource ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteInventoryResource

Delete an Inventory Resource

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

A canonical of an organization.

inventory_resource_id
required
integer <uint32>

Inventory Resource ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updateInventoryResource

Create an Inventory Resource

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

A canonical of an organization.

inventory_resource_id
required
integer <uint32>

Inventory Resource ID

Request Body schema:
required

The information of the Inventory new data

provider
required
string

The provider of the created Resource

type
required
string

The type of the resource

name
required
string

The name of the resource

custom_attributes
object

List of attributes (key value object) of the Resource, can be anything

label
required
string

A way to distinguish and categorize resources

memory
integer <uint64> >= 0

The amount of memory that it has in MB

cpu
integer <uint64> >= 0

The amount of cpu cores that it has in units

storage
integer <uint64> >= 0

The amount of storage that it has in MB

Responses

Request samples

Content type
{
  • "provider": "string",
  • "type": "string",
  • "name": "string",
  • "custom_attributes": {
    },
  • "label": "my-label",
  • "memory": 0,
  • "cpu": 0,
  • "storage": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Inventory Plan

getInventoryPlan

Get the terraform plan of the inventory. It uses '-' as the Concourse resource that uses it automatically adds '-plan' on it's implementation to push the plan. So to simplify the configuration we use '-' also.

query Parameters
jwt
required
string

Token with the information about state and credentials.

Responses

Response samples

Content type
application/json
{ }

setInventoryPlan

Create or replace an Inventory plan

query Parameters
jwt
required
string

Token with the information about state and credentials.

Request Body schema: application/json

The plan of the Inventory

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization licence

getLicence

Get currently active licence.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

activateLicence

Activate Cycloid's licence. If another licence already exists, it will be overwritten

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

A canonical of an organization.

Request Body schema:
required

The licence key

key
required
string

Licence's key in the JWT format

Responses

Request samples

Content type
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Environment pipelines

getEnvironmentPipelines

Get the pipelines that the authenticated user has access to.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

environment_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

The environment canonical to use as part of a path

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization pipelines

getPipelines

Get all the pipelines that the authenticated user has access to.

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

A canonical of an organization.

query Parameters
concourse_pipeline_name
string [ 1 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_.]+[a-z0-9]+$

A pipeline name

project_canonical
string^[\da-z]+(?:(?:[\da-z\-._]+)?[\da-z])?$

A list of projects' canonical to filter from

environment_canonical
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A list of environments' canonical to filter from

statuses
Array of strings unique
Items Enum: "aborted" "errored" "failed" "paused" "pending" "started" "succeeded"

List of statuses that you want to filter a pipeline/job with. Pipeline can be either paused or unpaused, but jobs can be started, pending, succeeded, failed, errored, aborted. So if any of a pipeline's job has one of the given status, the associated pipeline will be included in the response.

page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Project pipelines

getProjectPipelines

Get the pipelines that the authenticated user has access to.

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

A canonical of an organization.

project_canonical
required
string [ 1 .. 100 ] characters ^[\da-zA-Z]+(?:(?:[\da-zA-Z\-._]+)?[\da-zA-Z]...

A canonical of a project.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization Plugin Managers

createPluginManager

Create a new Plugin Manager instance registration

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

A canonical of an organization.

Request Body schema:
required

The data of the Plugin Manager to create.

name
required
string

Name assigned to the Plugin Manager Instance

url
required
string <uri> >= 0

URL of the Plugin Version

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPluginManagers

List Plugin Manager registrations

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getPluginManager

Get the data of Plugin Manager registration

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

A canonical of an organization.

plugin_manager_id
required
integer <uint32>

A plugin manager id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

deletePluginManager

Delete a Plugin Manager instance registration

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

A canonical of an organization.

plugin_manager_id
required
integer <uint32>

A plugin manager id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updatePluginManager

Update an Organization Plugin Manager

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

A canonical of an organization.

plugin_manager_id
required
integer <uint32>

A plugin manager id

Request Body schema:
required

Data needed to update an Organization Plugin Manager entity

invite_status
required
string
Enum: "accepted" "rejected"

Invite status to be set by the Plugin Manager update

Responses

Request samples

Content type
{
  • "invite_status": "accepted"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Plugins

listPluginRegistries

Get list of Plugin Registries.

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createPluginRegistry

Create a new Plugin Registry

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

A canonical of an organization.

Request Body schema:
required

The information of the Plugin Registry to create.

name
required
string

Name assigned to the Repository

url
required
string <uri> >= 0

URL of the Plugin Registry

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePluginRegistry

Delete a Plugin Registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updatePluginRegistry

Update the Plugin Registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

Request Body schema:
required

The information of the Plugin Registry update

name
required
string

Name assigned to the Repository

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPluginVersions

Get list of Plugin Versions.

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createPluginRegistryPluginVersion

Create a new Plugin

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

Request Body schema:
required

The information of the Plugin Version to create

url
required
string <uri> >= 0

URL of the Plugin Version

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPluginRegistryPluginVersionLogs

Get list of Plugin Version Logs.

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

A canonical of an organization.

plugin_id
required
integer <uint32>

A plugin id

plugin_version_id
required
integer <uint32>

A plugin version id

plugin_registry_id
required
integer <uint32>

A plugin registry id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getPluginRegistryPluginVersion

Get a Plugin Version from the registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

plugin_version_id
required
integer <uint32>

A plugin version id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePluginRegistryPluginVersion

Delete a Plugin Registry Version

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

plugin_version_id
required
integer <uint32>

A plugin version id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

retryPluginRegistryPluginVersion

Retry a Plugin Registry Version

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

plugin_version_id
required
integer <uint32>

A plugin version id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listPluginWidgets

Fetch all plugin widgets for an organization filtered by placement

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

A canonical of an organization.

query Parameters
placement
required
string

The placement type to filter widgets by (e.g. "tab", "component")

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getPluginWidgetData

Query data for a table plugin widget via the plugin manager.

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

A canonical of an organization.

widget_id
required
integer <uint32>

A widget id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getPluginWidgetIframeProxy

Proxy a GET request to the plugin for a widget iframe.

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

A canonical of an organization.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

postPluginWidgetIframeProxy

Proxy a POST request to the plugin for a widget iframe.

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

A canonical of an organization.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

putPluginWidgetIframeProxy

Proxy a PUT request to the plugin for a widget iframe.

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

A canonical of an organization.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

deletePluginWidgetIframeProxy

Proxy a DELETE request to the plugin for a widget iframe.

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

A canonical of an organization.

widget_id
required
integer <uint32>

A widget id

api_key
required
string

An API key used for authentication embedded in the URL path

query Parameters
path
string

Sub-path to proxy to the plugin

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

createPlugin

Install a Plugin Version

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

plugin_version_id
required
integer <uint32>

A plugin version id

Request Body schema:
required

Data of the Plugin to install

required
object

Stack Forms syntax configuration

Responses

Request samples

Content type
{
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPlugins

Get a list of all organization Plugins

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

A canonical of an organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createPluginRegistryPlugin

Create a new Registry Plugin

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

Request Body schema:
required

The information of the Registry Plugin to create

name
required
string

Name assigned to the Repository

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPluginRegistryPlugins

Get a list of Registry Plugins

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

listPluginLogs

Get list of Plugin Install Logs.

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

A canonical of an organization.

plugin_install_id
required
integer <uint32>

A plugin install id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getPluginRegistryPlugin

Get a Plugin from the Registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePluginRegistryPlugin

Delete a Plugin from the Registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

updatePluginRegistryPlugin

Update the Plugin on the Registry

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

A canonical of an organization.

plugin_registry_id
required
integer <uint32>

A plugin registry id

plugin_id
required
integer <uint32>

A plugin id

Request Body schema:
required

The information of the Plugin Registry update

name
required
string

Name assigned to the Plugin

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

updatePlugin

Update a Plugin Install

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

A canonical of an organization.

plugin_install_id
required
integer <uint32>

A plugin install id

Request Body schema:
required

Data for the Plugin Install update

plugin_version_id
required
integer <uint32> >= 1

ID of the new Plugin Version of the Plugin on the Plugin Registry

required
object

Stack Forms syntax configuration

Responses

Request samples

Content type
{
  • "plugin_version_id": 1,
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePlugin

Delete a Plugin Install

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

A canonical of an organization.

plugin_install_id
required
integer <uint32>

A plugin install id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getPlugin

Get a Plugin

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

A canonical of an organization.

plugin_install_id
required
integer <uint32>

A plugin install id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Policies

getPolicies

Get the list of Policies

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization Quotas

listQuotas

List of quotas available in the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createQuota

Create a new quota available in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization's quota to create.

memory
required
integer <uint64> >= 0

The amount of memory that it has in MB

cpu
required
integer <uint64> >= 0

The amount of cpu that it has in units

storage
required
integer <uint64> >= 0

The amount of storage that it has in MB

resource_pool_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The Resource Pool it'll be used

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

The Team it'll be limiting

Responses

Request samples

Content type
{
  • "memory": 0,
  • "cpu": 0,
  • "storage": 0,
  • "resource_pool_canonical": "string",
  • "team_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getQuota

Get the quota available in the organization with an canonical

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

A canonical of an organization.

quota_id
required
integer <uint32>

Quota ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateQuota

Update an existing quota in the organization.

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

A canonical of an organization.

quota_id
required
integer <uint32>

Quota ID

Request Body schema:
required

The information of the organization's quota to update.

memory
required
integer <uint64> >= 0

The amount of memory that it has in MB

cpu
required
integer <uint64> >= 0

The amount of cpu that it has in units

storage
required
integer <uint64> >= 0

The amount of storage that it has in MB

Responses

Request samples

Content type
{
  • "memory": 0,
  • "cpu": 0,
  • "storage": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteQuota

Delete an existing quota in the organization.

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

A canonical of an organization.

quota_id
required
integer <uint32>

Quota ID

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listQuotaConsumptions

Get the quota consumptions by project and environment

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

A canonical of an organization.

quota_id
required
integer <uint32>

Quota ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Resource Pools

listResourcePools

List of resource pools available in the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createResourcePool

Create a new resource pool available in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization's resource_pool to create.

name
required
string
label
required
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateResourcePool

Update an existing resource_pool in the organization.

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

A canonical of an organization.

resource_pool_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Resource Pool canonical

Request Body schema:
required

The information of the organization's resource_pool to update.

name
required
string
label
required
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteResourcePool

Delete an existing resource_pool in the organization.

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

A canonical of an organization.

resource_pool_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Resource Pool canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization ResourcePools

getResourcePool

Get the resource pool available in the organization with an canonical

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

A canonical of an organization.

resource_pool_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Resource Pool canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organization Roles

getRoles

Get the list of roles available in the organization.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createRole

Create a new role available in the organization.

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

A canonical of an organization.

Request Body schema:
required

The information of the organization's role to create.

name
required
string [ 3 .. 100 ] characters
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
description
string
required
Array of objects (NewRule)

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "description": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getRole

Get the role available in the organization with an canonical

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

A canonical of an organization.

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Role canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateRole

Update an existing role in the organization.

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

A canonical of an organization.

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Role canonical

Request Body schema:
required

The information of the organization's role to update.

name
required
string [ 3 .. 100 ] characters
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
description
string
required
Array of objects (NewRule)

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "description": "string",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteRole

Delete an existing role in the organization.

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

A canonical of an organization.

role_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Role canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization Service Catalog Sources

getServiceCatalogSources

Return all the private service catalogs

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createServiceCatalogSource

Creates a Service catalog source

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

A canonical of an organization.

Request Body schema:
required

The information of the organization to create.

name
required
string
canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...
branch
required
string
credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
owner
string

User canonical that owns this service catalog source. If omitted then the person creating this service catalog source will be assigned as owner. When a user is the owner of a service catalog source they has all the permissions on it.

visibility
string

The visibility setting allows to specify which visibility will be applied to stacks in this catalog repository. This option is only applied during initial catalog repository creation, not for subsequent updates.

team_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Team responsible for the maintenance of the underlying service catalogs

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "url": "string",
  • "branch": "string",
  • "credential_canonical": "string",
  • "owner": "string",
  • "visibility": "string",
  • "team_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

refreshServiceCatalogSource

Refresh a Service catalog source. It compares changes between the remote repository and the local youdeploy database. The response contains stacks that have been successfully refreshed along with the stacks that errored.

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

getServiceCatalogSource

Return the Service Catalog Source

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateServiceCatalogSource

Update a Service catalog source

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Request Body schema:
required

The information of the organization to create.

name
required
string
url
required
string^((/|~)[^/]*)+.(\.git)|(([\w\]+@[\w\.]+))(:(/...
branch
string
credential_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
owner
string

User canonical that owns this service catalog source. If omitted then the person creating this service catalog source will be assigned as owner. When a user is the owner of a service catalog source they has all the permissions on it.

Responses

Request samples

Content type
{
  • "name": "string",
  • "url": "string",
  • "branch": "string",
  • "credential_canonical": "string",
  • "owner": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteServiceCatalogSource

delete a Service catalog source

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

validateServiceCatalogSource

Validate a Service catalog source

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

listServiceCatalogSourceVersions

List Service catalog source versions

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

refreshServiceCatalogSourceVersions

List Service catalog source versions

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

A canonical of an organization.

service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Organization Service Catalog Sources canonical

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Organization team members

getTeamMembers

Get the members of a team of the organization.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "pagination": {
    }
}

assignMemberToTeam

Assign a user of the organization to be a member of a team.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

Request Body schema:
required

The assignation information for being a member or being updated.

username
string <string>

Assign user by username

email
string <email>

Assign user by email (can be used for users who didn't accept the invitation yet and have no username)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getTeamMember

Get the information of a member of the team.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

unassignMemberFromTeam

Unassign a member of the team. After this operation, the user will not be a member of the team.

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

A canonical of an organization.

team_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A canonical of a team.

member_id
required
integer <uint32>

A member id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Organization workers

getWorkers

Get the workers that the authenticated user has access to.

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

SAML2

samlAssertionConsumerService

Assertion Consumer Service callback endpoint for the SAML2 Identity Provider.

Request Body schema: application/x-www-form-urlencoded
SAMLResponse
string

Base64-encoded SAML authentication response document.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getSamlMetadata

Returns the Cycloid instance's SAML2 metadata that can be plugged into an Identity Provider.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Service catalogs

listServiceCatalogs

Return all the service catalogs

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

A canonical of an organization.

query Parameters
page_index
integer <uint32>
Default: 1

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

page_size
integer <uint32>
Default: 100

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

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getServiceCatalog

Get the information of the service catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateServiceCatalog

Update the information of the service catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Request Body schema:
required

The information of the ServiceCatalog Terraform.

visibility
required
string
team_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Team responsible for the maintenance of the underlying service catalogs

Responses

Request samples

Content type
{
  • "visibility": "string",
  • "team_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteServiceCatalog

Delete the service catalog.

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceCatalogUseCases

Fetch the use cases available for a given Service Catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

query Parameters
service_catalog_source_version_id
integer <uint32>

The ID of the SCS Version

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getServiceCatalogVersions

Fetch the versions available for a given Service Catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createServiceCatalogFromTemplate

Create a new Service Catalog using the ref and use case passed as template

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Request Body schema:
required

The information of the ServiceCatalog.

name
required
string
canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
author
string
service_catalog_source_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$
use_case
required
string [ 1 .. 100 ] characters (^[a-z0-9]+(([a-z0-9\-_]+)?[a-z0-9]+)?$)
visibility
string
team_canonical
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

Team responsible for the maintenance of the underlying service catalogs

Responses

Request samples

Content type
{
  • "name": "string",
  • "canonical": "string",
  • "author": "string",
  • "service_catalog_source_canonical": "string",
  • "use_case": "string",
  • "visibility": "string",
  • "team_canonical": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getServiceCatalogTerraform

Get the information of the service catalog Terraform config

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

use_case_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A use case canonical

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateServiceCatalogTerraform

Update/Create the information of the service catalog Terraform config

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

use_case_canonical
required
string [ 3 .. 100 ] characters ^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+$

A use case canonical

Request Body schema:
required

The information of the ServiceCatalog Terraform.

config
required
object

Responses

Request samples

Content type
{
  • "config": { }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceCatalogTerraformDiagram

Get the information of the service catalog Terraform diagram

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "created_at": 1503225026,
  • "updated_at": 1503335026
}

updateServiceCatalogTerraformDiagram

Update/Create the information of the service catalog Terraform diagram

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Request Body schema:
required

The information of the ServiceCatalog Terraform Diagram

any (TerraformDiagram)

The JSON Diagram structure

Responses

Request samples

Content type
null

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceCatalogTerraformImage

Get the SC TF Image

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateServiceCatalogTerraformImage

Update/Create the Image for the SC TF Image

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Request Body schema:
required

The information of the ServiceCatalog Terraform Diagram

image
required
string <byte>

Responses

Request samples

Content type
{
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

getServiceCatalogUsage

Get the usage of the Service Catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

validateServiceCatalogDependencies

Validates the dependencies of a Service Catalog

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

A canonical of an organization.

service_catalog_ref
required
string^[a-z0-9]+[a-z0-9\-_]+[a-z0-9]+:[a-z0-9]+[a-z...

A Service Catalog name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}