Codesphere managed-services API
The managed-services API from Codesphere — 5 operation(s) for managed-services.
OpenAPI Specification
openapi: 3.0.0
info:
title: Codesphere Public clusters managed-services API
version: 0.1.0
servers:
- url: https://cloud.codesphere.com/api
tags:
- name: managed-services
paths:
/managed-services/providers:
get:
summary: listProviders
tags:
- managed-services
parameters:
- name: teamId
in: query
required: false
schema:
type: integer
minimum: 0
responses:
'200':
description: Success.
content:
application/json:
schema:
type: array
items:
type: object
anyOf:
- type: object
properties:
name:
title: ProviderName
pattern: ^[a-z0-9-_]+$
type: string
version:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
schemaVersion:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
scope:
type: string
enum:
- global
- team
author:
type: string
backups:
type: object
properties:
configSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
required:
- configSchema
- secretsSchema
capabilities:
type: object
properties:
pause:
type: boolean
backups:
type: boolean
pointInTimeRecovery:
type: boolean
category:
type: string
description:
type: string
displayName:
type: string
iconUrl:
type: string
configSchema:
type: object
description: JSON Schema
detailsSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
plans:
type: array
items:
type: object
properties:
id:
type: integer
minimum: 0
name:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
properties:
pricedAs:
type: string
enum:
- cpu-tenths
- free
- network-bandwidth-mbps
- ram-mib
- replicas
- storage-mib
schema:
type: object
description: JSON Schema
required:
- schema
required:
- id
- name
- description
- parameters
versions:
example:
0.0.1:
ciProfile: debug
gitRef: 1a410efbd13591db07496601ebc7a059dd55cfe9
description: Initial release
1.0.0-rc:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: cac0cab538b970a37ea1e769cbbde608743bc96d
description: Release Candidate. Added feature X, Y and Z
1.0.0:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: fdf4fc3344e67ab068f836878b6c4951e3b15f3d
description: Long Term Support Release
type: object
additionalProperties:
type: object
properties:
gitRef:
type: string
ciProfile:
type: string
appVersion:
type: string
description:
type: string
required:
- gitRef
- ciProfile
propertyNames:
title: SemVer
type: string
description: A semantic version number
example: 1.0.0
backend:
type: object
properties:
landscape:
type: object
properties:
gitUrl:
type: string
ciProfile:
type: string
deprecated: true
description: Deprecated legacy fallback CI profile. A provider must define at least one version; as a temporary backwards-compatibility fallback, a provider without versions is still accepted as long as it defines this field.
required:
- gitUrl
required:
- landscape
createdAt:
type: string
format: date-time
required:
- name
- version
- schemaVersion
- author
- category
- description
- displayName
- iconUrl
- configSchema
- detailsSchema
- secretsSchema
- plans
- backend
- type: object
properties:
name:
title: ProviderName
pattern: ^[a-z0-9-_]+$
type: string
version:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
schemaVersion:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
scope:
type: string
enum:
- global
- team
author:
type: string
backups:
type: object
properties:
configSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
required:
- configSchema
- secretsSchema
capabilities:
type: object
properties:
pause:
type: boolean
backups:
type: boolean
pointInTimeRecovery:
type: boolean
category:
type: string
description:
type: string
displayName:
type: string
iconUrl:
type: string
configSchema:
type: object
description: JSON Schema
detailsSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
plans:
type: array
items:
type: object
properties:
id:
type: integer
minimum: 0
name:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
properties:
pricedAs:
type: string
enum:
- cpu-tenths
- free
- network-bandwidth-mbps
- ram-mib
- replicas
- storage-mib
schema:
type: object
description: JSON Schema
required:
- schema
required:
- id
- name
- description
- parameters
versions:
example:
0.0.1:
ciProfile: debug
gitRef: 1a410efbd13591db07496601ebc7a059dd55cfe9
description: Initial release
1.0.0-rc:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: cac0cab538b970a37ea1e769cbbde608743bc96d
description: Release Candidate. Added feature X, Y and Z
1.0.0:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: fdf4fc3344e67ab068f836878b6c4951e3b15f3d
description: Long Term Support Release
type: object
additionalProperties:
type: object
properties:
gitRef:
type: string
ciProfile:
type: string
appVersion:
type: string
description:
type: string
required:
- gitRef
- ciProfile
propertyNames:
title: SemVer
type: string
description: A semantic version number
example: 1.0.0
backend:
type: object
properties:
api:
type: object
properties:
endpoint:
type: string
secret:
type: string
required:
- endpoint
required:
- api
required:
- name
- version
- schemaVersion
- author
- category
- description
- displayName
- iconUrl
- configSchema
- detailsSchema
- secretsSchema
- plans
- backend
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 401
title:
type: string
detail:
type: string
traceId:
type: string
required:
- status
- title
- traceId
security:
- bearerAuth: []
operationId: managed-services-listProviders
post:
summary: createProvider
tags:
- managed-services
parameters: []
requestBody:
content:
application/json:
schema:
type: object
anyOf:
- type: object
properties:
author:
type: string
backups:
type: object
properties:
configSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
required:
- configSchema
- secretsSchema
capabilities:
type: object
properties:
pause:
type: boolean
backups:
type: boolean
pointInTimeRecovery:
type: boolean
category:
type: string
description:
type: string
displayName:
type: string
iconUrl:
type: string
configSchema:
type: object
description: JSON Schema
detailsSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
plans:
type: array
items:
type: object
properties:
id:
type: integer
minimum: 0
name:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
properties:
pricedAs:
type: string
enum:
- cpu-tenths
- free
- network-bandwidth-mbps
- ram-mib
- replicas
- storage-mib
schema:
type: object
description: JSON Schema
required:
- schema
required:
- id
- name
- description
- parameters
versions:
example:
0.0.1:
ciProfile: debug
gitRef: 1a410efbd13591db07496601ebc7a059dd55cfe9
description: Initial release
1.0.0-rc:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: cac0cab538b970a37ea1e769cbbde608743bc96d
description: Release Candidate. Added feature X, Y and Z
1.0.0:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: fdf4fc3344e67ab068f836878b6c4951e3b15f3d
description: Long Term Support Release
type: object
additionalProperties:
type: object
properties:
gitRef:
type: string
ciProfile:
type: string
appVersion:
type: string
description:
type: string
required:
- gitRef
- ciProfile
propertyNames:
title: SemVer
type: string
description: A semantic version number
example: 1.0.0
name:
title: ProviderName
pattern: ^[a-z0-9-_]+$
type: string
version:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
schemaVersion:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
backend:
type: object
properties:
landscape:
type: object
properties:
gitUrl:
type: string
ciProfile:
type: string
deprecated: true
description: Deprecated legacy fallback CI profile. A provider must define at least one version; as a temporary backwards-compatibility fallback, a provider without versions is still accepted as long as it defines this field.
required:
- gitUrl
required:
- landscape
scope:
type: object
anyOf:
- type: object
properties:
type:
type: string
enum:
- global
required:
- type
- type: object
properties:
type:
type: string
enum:
- team
teamIds:
type: array
items:
type: integer
minimum: 0
required:
- type
- teamIds
required:
- author
- category
- description
- displayName
- iconUrl
- configSchema
- detailsSchema
- secretsSchema
- plans
- name
- backend
- type: object
properties:
gitUrl:
type: string
gitRef:
type: string
scope:
type: object
anyOf:
- type: object
properties:
type:
type: string
enum:
- global
required:
- type
- type: object
properties:
type:
type: string
enum:
- team
teamIds:
type: array
items:
type: integer
minimum: 0
required:
- type
- teamIds
required:
- gitUrl
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
name:
title: ProviderName
pattern: ^[a-z0-9-_]+$
type: string
version:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
schemaVersion:
title: ProviderSchemaVersion
pattern: ^v[0-9][0-9a-z]*$
type: string
scope:
type: string
enum:
- global
- team
author:
type: string
backups:
type: object
properties:
configSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
required:
- configSchema
- secretsSchema
capabilities:
type: object
properties:
pause:
type: boolean
backups:
type: boolean
pointInTimeRecovery:
type: boolean
category:
type: string
description:
type: string
displayName:
type: string
iconUrl:
type: string
configSchema:
type: object
description: JSON Schema
detailsSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
plans:
type: array
items:
type: object
properties:
id:
type: integer
minimum: 0
name:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
properties:
pricedAs:
type: string
enum:
- cpu-tenths
- free
- network-bandwidth-mbps
- ram-mib
- replicas
- storage-mib
schema:
type: object
description: JSON Schema
required:
- schema
required:
- id
- name
- description
- parameters
versions:
example:
0.0.1:
ciProfile: debug
gitRef: 1a410efbd13591db07496601ebc7a059dd55cfe9
description: Initial release
1.0.0-rc:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: cac0cab538b970a37ea1e769cbbde608743bc96d
description: Release Candidate. Added feature X, Y and Z
1.0.0:
appVersion: Nextcloud v33
ciProfile: prod
gitRef: fdf4fc3344e67ab068f836878b6c4951e3b15f3d
description: Long Term Support Release
type: object
additionalProperties:
type: object
properties:
gitRef:
type: string
ciProfile:
type: string
appVersion:
type: string
description:
type: string
required:
- gitRef
- ciProfile
propertyNames:
title: SemVer
type: string
description: A semantic version number
example: 1.0.0
backend:
type: object
properties:
landscape:
type: object
properties:
gitUrl:
type: string
ciProfile:
type: string
deprecated: true
description: Deprecated legacy fallback CI profile. A provider must define at least one version; as a temporary backwards-compatibility fallback, a provider without versions is still accepted as long as it defines this field.
required:
- gitUrl
required:
- landscape
createdAt:
type: string
format: date-time
required:
- name
- version
- schemaVersion
- author
- category
- description
- displayName
- iconUrl
- configSchema
- detailsSchema
- secretsSchema
- plans
- backend
'400':
description: Path or request body variable does not match schema.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 400
title:
type: string
detail:
type: string
traceId:
type: string
required:
- status
- title
- traceId
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 401
title:
type: string
detail:
type: string
traceId:
type: string
required:
- status
- title
- traceId
security:
- bearerAuth: []
operationId: managed-services-createProvider
put:
summary: upsertProvider
tags:
- managed-services
parameters: []
requestBody:
content:
application/json:
schema:
type: object
anyOf:
- type: object
properties:
author:
type: string
backups:
type: object
properties:
configSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
required:
- configSchema
- secretsSchema
capabilities:
type: object
properties:
pause:
type: boolean
backups:
type: boolean
pointInTimeRecovery:
type: boolean
category:
type: string
description:
type: string
displayName:
type: string
iconUrl:
type: string
configSchema:
type: object
description: JSON Schema
detailsSchema:
type: object
description: JSON Schema
secretsSchema:
type: object
description: JSON Schema
plans:
type: array
items:
type: object
properties:
id:
type: integer
minimum: 0
name:
type: string
description:
type: string
parameters:
type: object
additionalProperties:
type: object
properties:
pricedAs:
type: string
# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/openapi/codesphere-managed-services-api-openapi.yml