CanaryCD API 0.1.dev0

Continuous Deployment API for Container and Static Pages

License: Apache 2.0

Git Key

GET /git-key/

List all Git Keys

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`offset`	query	integer	0	No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "name": "string",
        "auth_type": "string",
        "public_key": null,
        "projects": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/GitKeyDetails"
    },
    "title": "Response Git Key List Git Key  Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /git-key/

Create a Git Key

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "name": "string",
    "auth_type": "string",
    "auth_key": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "name": {
            "type": "string",
            "title": "Name"
        },
        "auth_type": {
            "type": "string",
            "title": "Auth Type"
        },
        "auth_key": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Auth Key"
        }
    },
    "type": "object",
    "required": [
        "name",
        "auth_type"
    ],
    "title": "GitKeyCreate"
}

Response 201 Created

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "auth_type": "string",
    "public_key": null,
    "projects": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "name": {
            "type": "string",
            "title": "Name"
        },
        "auth_type": {
            "type": "string",
            "title": "Auth Type"
        },
        "public_key": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Public Key"
        },
        "projects": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/Project"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Projects",
            "default": []
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "name",
        "auth_type",
        "public_key"
    ],
    "title": "GitKeyDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /git-key/{name}

Get Git Key Details

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Response 200 OK

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "auth_type": "string",
    "public_key": null,
    "projects": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "name": {
            "type": "string",
            "title": "Name"
        },
        "auth_type": {
            "type": "string",
            "title": "Auth Type"
        },
        "public_key": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Public Key"
        },
        "projects": {
            "anyOf": [
                {
                    "items": {
                        "$ref": "#/components/schemas/Project"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Projects",
            "default": []
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "name",
        "auth_type",
        "public_key"
    ],
    "title": "GitKeyDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /git-key/{name}

Delete a Key

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Project

GET /project/

List Projects

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`offset`	query	integer	0	No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "id": "4a4f760f-d4fb-49d8-ac8e-283b33c3c4dd",
        "name": "string",
        "remote": null,
        "git_key": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ProjectDetails"
    },
    "title": "Response Project List Project  Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /project/

Create a Project

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "key": null,
    "remote": null,
    "name": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "key": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Key"
        },
        "remote": {
            "anyOf": [
                {
                    "type": "string",
                    "pattern": "^(?:(https?|git|ssh):\\/\\/)?(?:([^@\\/:]+)(?::([^@\\/:]+))?@)?([^:\\/]+)(?::(\\d+))?(?:[\\/:](.+?))(?:(\\.git))?$"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Remote",
            "examples": [
                "git@github.com:namespace/github/repo.git"
            ]
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name",
            "examples": [
                "project-name"
            ]
        }
    },
    "type": "object",
    "required": [
        "name"
    ],
    "title": "ProjectCreate"
}

Response 201 Created

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "id": "36999089-aeb9-4214-ad4e-c2fae892986b",
    "name": "string",
    "remote": null,
    "git_key": null,
    "token": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name",
            "examples": [
                "project-name"
            ]
        },
        "remote": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Remote",
            "examples": [
                "git@github.com:namespace/github/repo.git"
            ]
        },
        "git_key": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/GitKeyDetails"
                },
                {
                    "type": "null"
                }
            ]
        },
        "token": {
            "type": "string",
            "title": "Token"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "id",
        "name",
        "git_key",
        "token"
    ],
    "title": "ProjectCreatedDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /project/{name}

Get Project Details

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Response 200 OK

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "id": "4357fa7d-074e-4237-a472-9937ebbe8e77",
    "name": "string",
    "remote": null,
    "git_key": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name",
            "examples": [
                "project-name"
            ]
        },
        "remote": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Remote",
            "examples": [
                "git@github.com:namespace/github/repo.git"
            ]
        },
        "git_key": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/GitKeyDetails"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "id",
        "name",
        "git_key"
    ],
    "title": "ProjectDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /project/{name}

Update a Project

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Request body

application/json

{
    "key": null,
    "remote": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "key": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Key"
        },
        "remote": {
            "anyOf": [
                {
                    "type": "string",
                    "pattern": "^(?:(https?|git|ssh):\\/\\/)?(?:([^@\\/:]+)(?::([^@\\/:]+))?@)?([^:\\/]+)(?::(\\d+))?(?:[\\/:](.+?))(?:(\\.git))?$"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Remote",
            "examples": [
                "git@github.com:namespace/github/repo.git"
            ]
        }
    },
    "type": "object",
    "title": "ProjectUpdate"
}

Response 200 OK

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "id": "ba5b9b81-34f3-48c6-9f7d-134015001987",
    "name": "string",
    "remote": null,
    "git_key": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name",
            "examples": [
                "project-name"
            ]
        },
        "remote": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Remote",
            "examples": [
                "git@github.com:namespace/github/repo.git"
            ]
        },
        "git_key": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/GitKeyDetails"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "id",
        "name",
        "git_key"
    ],
    "title": "ProjectDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /project/{name}

Delete a Project

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /project/{name}/refresh-token

Refresh Deploy Token

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`name`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /project/{name}/deploy/{environment}

Project Deploy

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`name`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /project/{name}/status/{environment}

Project Status

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`name`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Environment

GET /env/{project}/

Envs List

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`offset`	query	integer	0	No
`project`	path	string		No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "branch": "string",
        "name": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/EnvDetails"
    },
    "title": "Response Envs List Env  Project   Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /env/{project}/

Env Create

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`project`	path	string		No

Request body

application/json

{
    "branch": "string",
    "name": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "branch": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Branch"
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name"
        }
    },
    "type": "object",
    "required": [
        "branch",
        "name"
    ],
    "title": "EnvBase"
}

Response 201 Created

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "branch": "string",
    "name": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "branch": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Branch"
        },
        "name": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^([a-z]{1})[a-z0-9-]+$",
            "title": "Name"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "branch",
        "name"
    ],
    "title": "EnvDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /env/{project}/{environment}/

Set or Update Environment Variable

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`project`	path	string		No

Request body

application/json

{
    "key": "string",
    "value": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "key": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^[A-Z0-9_]+$",
            "title": "Key",
            "examples": [
                "FOO"
            ]
        },
        "value": {
            "type": "string",
            "maxLength": 1024,
            "minLength": 1,
            "title": "Value",
            "examples": [
                "value"
            ]
        }
    },
    "type": "object",
    "required": [
        "key",
        "value"
    ],
    "title": "VariableUpdate"
}

Response 200 OK

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "key": "string",
    "id": "37bdae0a-ee1c-41a4-822f-c0aefac83398",
    "environment_id": "7d4fe4db-85d0-4e99-b0a5-e4ad020ec6c6"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "key": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^[A-Z0-9_]+$",
            "title": "Key",
            "examples": [
                "FOO"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        },
        "environment_id": {
            "type": "string",
            "format": "uuid",
            "title": "Environment Id"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "key",
        "id",
        "environment_id"
    ],
    "title": "VariableDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /env/{project}/{environment}/

Delete Environment

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`project`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /env/{project}/{environment}/

List Variables

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`limit`	query	integer	100	No
`offset`	query	integer	0	No
`project`	path	string		No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "key": "string",
        "id": "e14fb40b-b4c1-4d32-9736-7d3e21710228",
        "environment_id": "3172ce4f-30b4-4ade-9ed7-e880441facf0",
        "value": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/VariableValueDetails"
    },
    "title": "Response Variable List Env  Project   Environment   Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /env/{project}/{environment}/{variable}/

Variable Unset

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`environment`	path	string		No
`project`	path	string		No
`variable`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Page

GET /page/

List all pages

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`offset`	query	integer	0	No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "fqdn": "string",
        "id": "07ff5cac-9d08-49a5-9ecb-b1c01b0bde03"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/PageDetails"
    },
    "title": "Response Page List Page  Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /page/

Create a new page

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "fqdn": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "fqdn": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Fqdn"
        }
    },
    "type": "object",
    "required": [
        "fqdn"
    ],
    "title": "PageBase"
}

Response 201 Created

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "fqdn": "string",
    "id": "6c72708b-97d8-4a61-93c7-8b0a23cc8d7f"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "fqdn": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Fqdn"
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "fqdn",
        "id"
    ],
    "title": "PageDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /page/{fqdn}

Page Delete

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`fqdn`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /page/{fqdn}/refresh-token

Page Deploy Key

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`fqdn`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /page/{fqdn}/deploy

Deploy a page

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`fqdn`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Redirect

GET /redirect/

List Redirects

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`offset`	query	integer	0	No

Response 200 OK

application/json

[
    {
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "source": "string",
        "destination": "string",
        "id": "b764de84-fdbc-4439-9cc8-8ee6eab0f06f"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/RedirectDetails"
    },
    "title": "Response Redirect List Redirect  Get"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /redirect/

Create a new Redirect

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "source": "string",
    "destination": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "source": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Source",
            "examples": [
                "example.com"
            ]
        },
        "destination": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Destination",
            "examples": [
                "example.com"
            ]
        }
    },
    "type": "object",
    "required": [
        "source",
        "destination"
    ],
    "title": "RedirectCreate"
}

Response 201 Created

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "source": "string",
    "destination": "string",
    "id": "ca239003-3ed5-434e-91f1-58c687132656"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "source": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Source",
            "examples": [
                "example.com"
            ]
        },
        "destination": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Destination",
            "examples": [
                "example.com"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "source",
        "destination",
        "id"
    ],
    "title": "RedirectDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /redirect/{fqdn}

Update a Redirect

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`fqdn`	path	string		No

Request body

application/json

{
    "destination": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "destination": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Destination",
            "examples": [
                "example.com"
            ]
        }
    },
    "type": "object",
    "required": [
        "destination"
    ],
    "title": "RedirectUpdate"
}

Response 200 OK

application/json

{
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "source": "string",
    "destination": "string",
    "id": "e8f3227a-2302-4e5b-88d0-0d3e31f6b7d9"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At",
            "examples": [
                "1999-12-31T23:59:59.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At",
            "examples": [
                "2000-01-01T00:00:00.000Z"
            ]
        },
        "source": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Source",
            "examples": [
                "example.com"
            ]
        },
        "destination": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1,
            "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
            "title": "Destination",
            "examples": [
                "example.com"
            ]
        },
        "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
        }
    },
    "type": "object",
    "required": [
        "created_at",
        "updated_at",
        "source",
        "destination",
        "id"
    ],
    "title": "RedirectDetails"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /redirect/{fqdn}

Delete a Redirect

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`fqdn`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Deploy-hooks

GET /deploy/project/{token}/{environment}

Token Deploy Project

Input parameters

Parameter	In	Type	Default	Nullable	Description
`environment`	path	string		No
`token`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /deploy/project/{token}

Token Deploy Project

Input parameters

Parameter	In	Type	Default	Nullable	Description
`environment`	query	string		No
`token`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /deploy/page/{token}

Token Deploy Page

Input parameters

Parameter	In	Type	Default	Nullable	Description
`token`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Config

GET /config/

List Config

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Response 200 OK

application/json

[
    {
        "key": "string",
        "value": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "items": {
        "$ref": "#/components/schemas/Config"
    },
    "type": "array",
    "title": "Response List Config Config  Get"
}

Response 404 Not Found

PUT /config/

Set Config

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "key": "string",
    "value": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "key": {
            "type": "string",
            "maxLength": 32,
            "minLength": 1,
            "title": "Key"
        },
        "value": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1,
            "title": "Value"
        }
    },
    "type": "object",
    "required": [
        "key",
        "value"
    ],
    "title": "Config",
    "description": "Daemon configuration"
}

Response 200 OK

application/json

{
    "key": "string",
    "value": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "key": {
            "type": "string",
            "maxLength": 32,
            "minLength": 1,
            "title": "Key"
        },
        "value": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1,
            "title": "Value"
        }
    },
    "type": "object",
    "required": [
        "key",
        "value"
    ],
    "title": "Config",
    "description": "Daemon configuration"
}

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /config/{key}

Unset Config

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`key`	path	string		No

Response 200 OK

application/json

Schema of the response body

Response 404 Not Found

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas

Config

Name	Type
`key`	string
`value`	string

EnvBase

Name	Type
`branch`	string
`name`	string

EnvDetails

Name	Type
`branch`	string
`created_at`	string(date-time)
`name`	string
`updated_at`	string(date-time)

EnvUpdate

Name	Type
`branch`	string

GitKeyCreate

Name	Type
`auth_key`
`auth_type`	string
`name`	string

GitKeyDetails

Name	Type
`auth_type`	string
`created_at`	string(date-time)
`name`	string
`projects`
`public_key`
`updated_at`	string(date-time)

HTTPValidationError

Name	Type
`detail`	Array<ValidationError>

PageBase

Name	Type
`fqdn`	string

PageDetails

Name	Type
`created_at`	string(date-time)
`fqdn`	string
`id`	string(uuid)
`updated_at`	string(date-time)

Project

Name	Type
`created_at`	string(date-time)
`git_key_id`
`id`	string(uuid)
`name`	string
`remote`
`token`
`updated_at`	string(date-time)

ProjectCreate

Name	Type
`key`
`name`	string
`remote`

ProjectCreatedDetails

Name	Type
`created_at`	string(date-time)
`git_key`
`id`	string(uuid)
`name`	string
`remote`
`token`	string
`updated_at`	string(date-time)

ProjectDetails

Name	Type
`created_at`	string(date-time)
`git_key`
`id`	string(uuid)
`name`	string
`remote`
`updated_at`	string(date-time)

ProjectUpdate

Name	Type
`key`
`remote`

RedirectCreate

Name	Type
`destination`	string
`source`	string

RedirectDetails

Name	Type
`created_at`	string(date-time)
`destination`	string
`id`	string(uuid)
`source`	string
`updated_at`	string(date-time)

RedirectUpdate

Name	Type
`destination`	string

ValidationError

Name	Type
`loc`	Array<>
`msg`	string
`type`	string

VariableDetails

Name	Type
`created_at`	string(date-time)
`environment_id`	string(uuid)
`id`	string(uuid)
`key`	string
`updated_at`	string(date-time)

VariableUpdate

Name	Type
`key`	string
`value`	string

VariableValueDetails

Name	Type
`created_at`	string(date-time)
`environment_id`	string(uuid)
`id`	string(uuid)
`key`	string
`updated_at`	string(date-time)
`value`

Security schemes

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2

Was this page helpful?