docs.jsonld
type: ApiDocumentation
title: API Bunnyshell Environments
description: Interact with Bunnyshell Platform
entrypoint: /api
supported class: admin/hashid
supported class: admin/hosting-clusters
supported class: admin/organization
supported class: admin/user
supported class: admin/workspace/golden-images
supported class: role
supported class: team_member
supported class: permission
supported class: organization_member
supported class: team
supported class: policy
supported class: resource_matcher
supported class: external_v1_ai_sandbox
supported class: external_v1_environment
supported class: external_v1_environment_variable
supported class: external_v1_environ_item
supported class: external_v1_event
supported class: external_v1_kubernetes_integration
supported class: external_v1_organization
supported class: external_v1_pipeline
supported class: external_v1_project
supported class: external_v1_project_variable
supported class: external_v1_registry_integration
supported class: external_v1_ssh
supported class: external_v1_secret
supported class: external_v1_componentEndpoint
supported class: external_v1_componentGit
supported class: external_v1_component
supported class: external_v1_service_component_variable
supported class: external_v1_template
supported class: external_v1_templates_repository
supported class: external_v1_workflow
supported class: Addon
supported class: Application
supported class: ApplyConfigurationJob
supported class: BillingProduct
supported class: BillingProfile
supported class: BunnyshellVolumesAddon
supported class: CloudProvider
supported class: CostTrackingAddon
supported class: CustomDockerImageComponent
supported class: Database
supported class: DockerImageComponent
supported class: Environment
supported class: EnvironmentTimeframe
supported class: EnvironmentVariable
supported class: Event
supported class: GenericComponent
supported class: GitIntegration
supported class: GitProvider
supported class: GitRepository
supported class: GoldenImage
supported class: HelmComponent
supported class: IngressControllerAddon
supported class: InitContainerComponent
supported class: KubernetesDashboardAddon
supported class: KubernetesIntegration
supported class: KubernetesManifestComponent
supported class: LogEntry
supported class: Organization
supported class: OrganizationUser
supported class: Project
supported class: ProjectTimeframe
supported class: ProjectVariable
supported class: RegistryIntegration
supported class: RegistryProvider
supported class: Service
supported class: ServiceComponentVariable
supported class: SidecarContainerComponent
supported class: SlackIntegration
supported class: StaticApplication
supported class: TeamsIntegration
supported class: Template
supported class: TemplatesRepository
supported class: TerraformComponent
supported class: Timeframe

admin/hashid
type: Class
title: admin/hashid
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: internalId
  title: internalId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hashable
  title: hashable
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: internalId
  title: internalId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hashId
  title: hashId
  required: true
  readable: true
  writeable: true
supported operation: Retrieves admin/hashid resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves admin/hashid resource.
  returns: admin/hashid

type
type: Property
domain: admin/hashid
range: string

internalId
type: Property
domain: admin/hashid
range: integer

hashable
type: Property
domain: admin/hashid

resource
type: Property
domain: admin/hashid

hashId
type: Property
domain: admin/hashid
range: string

admin/hosting-clusters
type: Class
title: admin/hosting-clusters
supported property: SupportedProperty
  property: hostingCluster
  title: hostingCluster
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: usableStatus
  title: usableStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: region
  title: region
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cloudProviderSlug
  title: cloudProviderSlug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterName
  title: clusterName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterServer
  title: clusterServer
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterCertificateAuthorityBase64
  title: clusterCertificateAuthorityBase64
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterUserClientCertificateBase64
  title: clusterUserClientCertificateBase64
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterUserClientKeyBase64
  title: clusterUserClientKeyBase64
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterUserToken
  title: clusterUserToken
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterCloudRegion
  title: clusterCloudRegion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterCloudProjectId
  title: clusterCloudProjectId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterCloudAccessKeyId
  title: clusterCloudAccessKeyId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterCloudSecretAccessKey
  title: clusterCloudSecretAccessKey
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workspaceSSHHostname
  title: workspaceSSHHostname
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  title: workspaceReservedK8sNamespaces
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: usableStatus
  title: usableStatus
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloudProviderSlug
  title: cloudProviderSlug
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterName
  title: clusterName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterServer
  title: clusterServer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterCertificateAuthorityBase64
  title: clusterCertificateAuthorityBase64
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterUserToken
  title: clusterUserToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterUserClientCertificateBase64
  title: clusterUserClientCertificateBase64
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterUserClientKeyBase64
  title: clusterUserClientKeyBase64
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterCloudRegion
  title: clusterCloudRegion
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterCloudProjectId
  title: clusterCloudProjectId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterCloudAccessKeyId
  title: clusterCloudAccessKeyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterCloudSecretAccessKey
  title: clusterCloudSecretAccessKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceSSHHostname
  title: workspaceSSHHostname
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  title: workspaceReservedK8sNamespaces
  required: true
  readable: true
  writeable: true
supported operation: Retrieves admin/hosting-clusters resource.
supported operation: Replaces the admin/hosting-clusters resource.
supported operation: Deletes the admin/hosting-clusters resource.

hostingCluster
type: Property
domain: admin/hosting-clusters

resource
type: Property
domain: admin/hosting-clusters

name
type: Property
domain: admin/hosting-clusters
range: string

usableStatus
type: Property
domain: admin/hosting-clusters
range: string

region
type: Property
domain: admin/hosting-clusters
range: string

cloudProviderSlug
type: Property
domain: admin/hosting-clusters
range: string

clusterName
type: Property
domain: admin/hosting-clusters
range: string

clusterServer
type: Property
domain: admin/hosting-clusters
range: string

clusterCertificateAuthorityBase64
type: Property
domain: admin/hosting-clusters
range: string

clusterUserClientCertificateBase64
type: Property
domain: admin/hosting-clusters
range: string

clusterUserClientKeyBase64
type: Property
domain: admin/hosting-clusters
range: string

clusterUserToken
type: Property
domain: admin/hosting-clusters
range: string

clusterCloudRegion
type: Property
domain: admin/hosting-clusters
range: string

clusterCloudProjectId
type: Property
domain: admin/hosting-clusters
range: string

clusterCloudAccessKeyId
type: Property
domain: admin/hosting-clusters
range: string

clusterCloudSecretAccessKey
type: Property
domain: admin/hosting-clusters
range: string

workspaceSSHHostname
type: Property
domain: admin/hosting-clusters
range: string

workspaceReservedK8sNamespaces
type: Property
domain: admin/hosting-clusters

clusterServer
type: Property
domain: admin/hosting-clusters
range: string
label: clusterUrl
domain: KubernetesIntegration
label: webhookUrl
domain: TeamsIntegration
label: gitRepositoryUrl
domain: TemplatesRepository

admin/organization
type: Class
title: admin/organization
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: realId
  title: realId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unique
  title: unique
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isGated
  title: isGated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billingMode
  title: billingMode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invoiceType
  title: invoiceType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountOwner
  title: accountOwner
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: activeOrganizationUsersCount
  title: activeOrganizationUsersCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billingPlanType
  title: billingPlanType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isGated
  title: isGated
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: billingMode
  title: billingMode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceType
  title: invoiceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountOwner
  title: accountOwner
  required: false
  readable: true
  writeable: true
supported operation: Retrieves admin/organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves admin/organization resource.
  returns: admin/organization
supported operation: Replaces the admin/organization resource.
  type: Operation
  type: ReplaceAction
  expects: admin/organization
  method: PUT
  title: Replaces the admin/organization resource.
  returns: admin/organization
supported operation: Deletes the admin/organization resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the admin/organization resource.
  returns: Nothing
supported operation: Replaces the admin/organization resource.
  type: Operation
  type: ReplaceAction
  expects: admin/organization
  method: PUT
  title: Replaces the admin/organization resource.
  returns: admin/organization

organization
type: Property
domain: admin/organization
max cardinality: 1
range: Organization

resource
type: Link
domain: admin/organization
max cardinality: 1
range: Organization

realId
type: Property
domain: admin/organization
range: integer

unique
type: Property
domain: admin/organization
range: string

name
type: Property
domain: admin/organization
range: string

isGated
type: Property
domain: admin/organization
range: boolean

billingMode
type: Property
domain: admin/organization
range: string

invoiceType
type: Property
domain: admin/organization
range: string

accountOwner
type: Link
domain: admin/organization
max cardinality: 1
range: admin/user
type: Property
range: integer

activeOrganizationUsersCount
type: Property
domain: admin/organization

billingPlanType
type: Property
domain: admin/organization

admin/user
type: Class
title: admin/user
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: registrationStep
  title: registrationStep
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: registrationStep
  title: registrationStep
  required: false
  readable: true
  writeable: true
supported operation: Retrieves admin/user resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves admin/user resource.
  returns: admin/user
supported operation: Replaces the admin/user resource.
  type: Operation
  type: ReplaceAction
  expects: admin/user
  method: PUT
  title: Replaces the admin/user resource.
  returns: admin/user
supported operation: Deletes the admin/user resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the admin/user resource.
  returns: Nothing

user
type: Property
domain: admin/user
max cardinality: 1
range: User

resource
type: Link
domain: admin/user
max cardinality: 1
range: User

email
type: Property
domain: admin/user
range: string

firstName
type: Property
domain: admin/user
range: string

lastName
type: Property
domain: admin/user
range: string

registrationStep
type: Property
domain: admin/user
range: string

email
type: Property
domain: admin/user
range: string
domain: User

password
type: Property
domain: admin/user
range: string

admin/workspace/golden-images
type: Class
title: admin/workspace/golden-images
supported property: SupportedProperty
  property: goldenImage
  title: goldenImage
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: current
  title: current
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: version
  title: version
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sourceUri
  title: sourceUri
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: storageClassName
  title: storageClassName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: diskSize
  title: diskSize
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: osName
  title: osName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: osVersion
  title: osVersion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: osArch
  title: osArch
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: defaultShell
  title: defaultShell
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: preinstalledPackages
  title: preinstalledPackages
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cloudInitPackages
  title: cloudInitPackages
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: slug
  title: slug
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sourceUri
  title: sourceUri
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: storageClassName
  title: storageClassName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: diskSize
  title: diskSize
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: osArch
  title: osArch
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: osName
  title: osName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: osVersion
  title: osVersion
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultShell
  title: defaultShell
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: preinstalledPackages
  title: preinstalledPackages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloudInitPackages
  title: cloudInitPackages
  required: false
  readable: true
  writeable: true
supported operation: Retrieves admin/workspace/golden-images resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves admin/workspace/golden-images resource.
  returns: admin/workspace/golden-images
supported operation: Replaces the admin/workspace/golden-images resource.
  type: Operation
  type: ReplaceAction
  expects: admin/workspace/golden-images
  method: PUT
  title: Replaces the admin/workspace/golden-images resource.
  returns: admin/workspace/golden-images
supported operation: Replaces the admin/workspace/golden-images resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the admin/workspace/golden-images resource.
  returns: admin/workspace/golden-images
supported operation: Replaces the admin/workspace/golden-images resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the admin/workspace/golden-images resource.
  returns: admin/workspace/golden-images
supported operation: Deletes the admin/workspace/golden-images resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the admin/workspace/golden-images resource.
  returns: Nothing

goldenImage
type: Property
domain: admin/workspace/golden-images
max cardinality: 1
range: GoldenImage

resource
type: Link
domain: admin/workspace/golden-images
max cardinality: 1
range: GoldenImage

slug
type: Property
domain: admin/workspace/golden-images
range: string

current
type: Property
domain: admin/workspace/golden-images
range: boolean

version
type: Property
domain: admin/workspace/golden-images
range: string

sourceUri
type: Property
domain: admin/workspace/golden-images
range: string

storageClassName
type: Property
domain: admin/workspace/golden-images
range: string

diskSize
type: Property
domain: admin/workspace/golden-images
range: string

osName
type: Property
domain: admin/workspace/golden-images
range: string

osVersion
type: Property
domain: admin/workspace/golden-images
range: string

osArch
type: Property
domain: admin/workspace/golden-images
range: string

defaultShell
type: Property
domain: admin/workspace/golden-images
range: string

preinstalledPackages
type: Property
domain: admin/workspace/golden-images

cloudInitPackages
type: Property
domain: admin/workspace/golden-images

description
type: Property
domain: admin/workspace/golden-images
range: string

role
type: Class
title: role
supported property: SupportedProperty
  property: teamMember
  title: teamMember
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: matchers
  title: matchers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: permissions
  title: permissions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamMatchers
  title: teamMatchers
  required: false
  readable: false
  writeable: false
supported operation: Retrieves role resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves role resource.
  returns: role

teamMember
type: Property
domain: role

resource
type: Property
domain: role

organization
type: Link
domain: role
max cardinality: 1
range: Organization

matchers
type: Property
domain: role

permissions
type: Property
domain: role

teamMatchers
type: Property
domain: role

team_member
type: Class
title: team_member
supported property: SupportedProperty
  property: teamMember
  title: teamMember
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationMember
  title: organizationMember
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: policies
  title: policies
  required: false
  readable: true
  writeable: false
supported operation: Retrieves team_member resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves team_member resource.
  returns: team_member

teamMember
type: Property
domain: team_member

resource
type: Property
domain: team_member

organization
type: Link
domain: team_member
max cardinality: 1
range: Organization

organizationMember
type: Property
domain: team_member
range: string

email
type: Property
domain: team_member
range: string

status
type: Property
domain: team_member
range: string

fullName
type: Property
domain: team_member
range: string

team
type: Property
domain: team_member
range: string

policies
type: Link
domain: team_member
range: policy

permission
type: Class
title: permission
supported property: SupportedProperty
  property: group
  title: group
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: dependencies
  title: dependencies
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: descriptions
  title: descriptions
  required: false
  readable: true
  writeable: false
supported operation: Retrieves permission resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves permission resource.
  returns: permission

group
type: Property
domain: permission

dependencies
type: Property
domain: permission

descriptions
type: Property
domain: permission
range: string

organization_member
type: Class
title: organization_member
supported property: SupportedProperty
  property: organizationMember
  title: organizationMember
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invitedBy
  title: invitedBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamMemberCount
  title: teamMemberCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: true
  writeable: false
supported operation: Retrieves organization_member resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves organization_member resource.
  returns: organization_member
supported operation: Creates a organization_member resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a organization_member resource.
  returns: organization_member
supported operation: Replaces the organization_member resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the organization_member resource.
  returns: organization_member

organizationMember
type: Property
domain: organization_member

resource
type: Property
domain: organization_member

invitedBy
type: Link
domain: organization_member
max cardinality: 1
range: User

user
type: Link
domain: organization_member
max cardinality: 1
range: User

email
type: Property
domain: organization_member
range: string

status
type: Property
domain: organization_member
range: string

fullName
type: Property
domain: organization_member
range: string

teamMemberCount
type: Property
domain: organization_member

organization
type: Link
domain: organization_member
max cardinality: 1
range: Organization

scope
type: Property
domain: organization_member

team
type: Class
title: team
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: canEditMembers
  title: canEditMembers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: canHaveNoMembers
  title: canHaveNoMembers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: resourceMatcherCount
  title: resourceMatcherCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamMemberCount
  title: teamMemberCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: matchedProjectCount
  title: matchedProjectCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: policyCount
  title: policyCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: predefined
  title: predefined
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: matchers
  title: matchers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: members
  title: members
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scope
  title: scope
  required: true
  readable: true
  writeable: true
supported operation: Retrieves team resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves team resource.
  returns: team
supported operation: Replaces the team resource.
  type: Operation
  type: ReplaceAction
  expects: team
  method: PUT
  title: Replaces the team resource.
  returns: team
supported operation: Deletes the team resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the team resource.
  returns: Nothing

team
type: Property
domain: team

resource
type: Property
domain: team

canEditMembers
type: Property
domain: team
range: boolean

canHaveNoMembers
type: Property
domain: team
range: boolean

resourceMatcherCount
type: Property
domain: team

teamMemberCount
type: Property
domain: team

matchedProjectCount
type: Property
domain: team

policyCount
type: Property
domain: team

name
type: Property
domain: team
range: string

description
type: Property
domain: team
range: string

predefined
type: Property
domain: team
range: boolean

organization
type: Link
domain: team
max cardinality: 1
range: Organization

scope
type: Property
domain: team

matchers
type: Property
domain: team
range: string

members
type: Property
domain: team

policy
type: Class
title: policy
supported property: SupportedProperty
  property: policy
  title: policy
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: permissions
  title: permissions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamCount
  title: teamCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamMemberCount
  title: teamMemberCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: predefined
  title: predefined
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: permissions
  title: permissions
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scope
  title: scope
  required: true
  readable: true
  writeable: true
supported operation: Retrieves policy resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves policy resource.
  returns: policy
supported operation: Replaces the policy resource.
  type: Operation
  type: ReplaceAction
  expects: policy
  method: PUT
  title: Replaces the policy resource.
  returns: policy
supported operation: Deletes the policy resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the policy resource.
  returns: Nothing

policy
type: Property
domain: policy

resource
type: Property
domain: policy

permissions
type: Property
domain: policy

teamCount
type: Property
domain: policy

teamMemberCount
type: Property
domain: policy

name
type: Property
domain: policy
range: string

description
type: Property
domain: policy
range: string

predefined
type: Property
domain: policy
range: boolean

organization
type: Link
domain: policy
max cardinality: 1
range: Organization

scope
type: Property
domain: policy

resource_matcher
type: Class
title: resource_matcher
supported property: SupportedProperty
  property: resourceMatcher
  title: resourceMatcher
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: inline
  title: inline
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectMatcher
  title: projectMatcher
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: environmentMatcher
  title: environmentMatcher
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamCount
  title: teamCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: predefined
  title: predefined
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: inline
  title: inline
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environment
  title: environment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scope
  title: scope
  required: true
  readable: true
  writeable: true
supported operation: Retrieves resource_matcher resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves resource_matcher resource.
  returns: resource_matcher
supported operation: Replaces the resource_matcher resource.
  type: Operation
  type: ReplaceAction
  expects: resource_matcher
  method: PUT
  title: Replaces the resource_matcher resource.
  returns: resource_matcher
supported operation: Deletes the resource_matcher resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the resource_matcher resource.
  returns: Nothing

resourceMatcher
type: Property
domain: resource_matcher

resource
type: Property
domain: resource_matcher

inline
type: Property
domain: resource_matcher
range: boolean

projectMatcher
type: Property
domain: resource_matcher

environmentMatcher
type: Property
domain: resource_matcher

teamCount
type: Property
domain: resource_matcher

name
type: Property
domain: resource_matcher
range: string

description
type: Property
domain: resource_matcher
range: string

predefined
type: Property
domain: resource_matcher
range: boolean

organization
type: Link
domain: resource_matcher
max cardinality: 1
range: Organization

scope
type: Property
domain: resource_matcher

project
type: Property
domain: resource_matcher

environment
type: Property
domain: resource_matcher

external_v1_ai_sandbox
type: Class
title: external_v1_ai_sandbox
supported property: SupportedProperty
  property: source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destination
  title: destination
  required: false
  readable: true
  writeable: true
description: Various tools for the AI Extension.

source
type: Property
domain: external_v1_ai_sandbox

destination
type: Property
domain: external_v1_ai_sandbox

external_v1_environment
type: Class
title: external_v1_environment
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: labels
  title: labels
  required: false
  readable: true
  writeable: false
  description: Environment labels.
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
  description: Environment type: primary or ephemeral.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Environment name.
supported property: SupportedProperty
  property: namespace
  title: namespace
  required: false
  readable: true
  writeable: false
  description: Environment k8s namespace.
supported property: SupportedProperty
  property: urlHandle
  title: urlHandle
  required: false
  readable: true
  writeable: false
  description: Environment url handle.
supported property: SupportedProperty
  property: totalComponents
  title: totalComponents
  required: false
  readable: true
  writeable: false
  description: Service component identifier
supported property: SupportedProperty
  property: operationStatus
  title: operationStatus
  required: false
  readable: true
  writeable: false
  description: Environment operation status.
supported property: SupportedProperty
  property: clusterStatus
  title: clusterStatus
  required: false
  readable: true
  writeable: false
  description: Environment cluster status.
supported property: SupportedProperty
  property: buildSettings
  title: buildSettings
  required: false
  readable: true
  writeable: false
  description: Environment build settings.
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: false
  description: Project identifier.
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration identifier.
supported property: SupportedProperty
  property: hostingRegion
  title: hostingRegion
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration managed hosting region.
supported property: SupportedProperty
  property: ephemeralKubernetesIntegration
  title: ephemeralKubernetesIntegration
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration identifier for the ephemeral auto deploy cluster.
supported property: SupportedProperty
  property: ephemeralHostingRegion
  title: ephemeralHostingRegion
  required: false
  readable: true
  writeable: false
  description: Hosting Region for the ephemeral auto deploy cluster.
supported property: SupportedProperty
  property: hasTerminationProtection
  title: hasTerminationProtection
  required: false
  readable: true
  writeable: false
  description: Environment termination protection.
supported property: SupportedProperty
  property: hasAutoUpdate
  title: hasAutoUpdate
  required: false
  readable: true
  writeable: false
  description: Environment auto update.
supported property: SupportedProperty
  property: hasRemoteDevelopmentAllowed
  title: hasRemoteDevelopmentAllowed
  required: false
  readable: true
  writeable: false
  description: Environment remote development allowed.
supported property: SupportedProperty
  property: hasEphemeralAutoDeploy
  title: hasEphemeralAutoDeploy
  required: false
  readable: true
  writeable: false
  description: Environment ephemeral auto deploy status.
supported property: SupportedProperty
  property: hasEphemeralCreateOnPr
  title: hasEphemeralCreateOnPr
  required: false
  readable: true
  writeable: false
  description: Environment ephemeral create-on-PR status.
supported property: SupportedProperty
  property: hasEphemeralDestroyOnPrClose
  title: hasEphemeralDestroyOnPrClose
  required: false
  readable: true
  writeable: false
  description: Environment ephemeral destroy-on-PR close status.
supported property: SupportedProperty
  property: hasEphemeralBranchWhitelist
  title: hasEphemeralBranchWhitelist
  required: false
  readable: true
  writeable: false
  description: Environment ephemeral branch whitelist status.
supported property: SupportedProperty
  property: ephemeralBranchWhitelistRegex
  title: ephemeralBranchWhitelistRegex
  required: false
  readable: true
  writeable: false
  description: Environment ephemeral branch whitelist regex.
supported property: SupportedProperty
  property: templateSettings
  title: templateSettings
  required: false
  readable: true
  writeable: false
  description: Environment template settings.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: genesis
  title: genesis
  required: false
  readable: true
  writeable: true
  description: The environment creation method
supported operation: Retrieves external_v1_environment resource.
supported operation: Creates a external_v1_environment resource.
supported operation: Replaces the external_v1_environment resource.
supported operation: Updates the external_v1_environment resource.
description: An environment holds a collection of buildable and deployable components.

entity
type: Link
domain: external_v1_environment
max cardinality: 1
range: Environment

labels
type: Property
domain: external_v1_environment
range: string

type
type: Property
domain: external_v1_environment
range: string

name
type: Property
domain: external_v1_environment
range: string

namespace
type: Property
domain: external_v1_environment
range: string

urlHandle
type: Property
domain: external_v1_environment
range: string

totalComponents
type: Property
domain: external_v1_environment

operationStatus
type: Property
domain: external_v1_environment
range: string

clusterStatus
type: Property
domain: external_v1_environment
range: string

buildSettings
type: Link
domain: external_v1_environment

project
type: Property
domain: external_v1_environment
range: string

kubernetesIntegration
type: Property
domain: external_v1_environment
range: string

hostingRegion
type: Property
domain: external_v1_environment
range: string

ephemeralKubernetesIntegration
type: Property
domain: external_v1_environment
range: string

ephemeralHostingRegion
type: Property
domain: external_v1_environment
range: string

hasTerminationProtection
type: Property
domain: external_v1_environment
range: boolean

hasAutoUpdate
type: Property
domain: external_v1_environment
range: boolean

hasRemoteDevelopmentAllowed
type: Property
domain: external_v1_environment
range: boolean

hasEphemeralAutoDeploy
type: Property
domain: external_v1_environment
range: boolean

hasEphemeralCreateOnPr
type: Property
domain: external_v1_environment
range: boolean

hasEphemeralDestroyOnPrClose
type: Property
domain: external_v1_environment
range: boolean

hasEphemeralBranchWhitelist
type: Property
domain: external_v1_environment
range: boolean

ephemeralBranchWhitelistRegex
type: Property
domain: external_v1_environment
range: string

templateSettings
type: Link
domain: external_v1_environment
type: Property

entityName
type: Property
domain: external_v1_environment

entityClass
type: Property
domain: external_v1_environment

genesis
type: Property
domain: external_v1_environment

remoteDevelopmentAllowed
type: Property
domain: external_v1_environment
range: boolean

autoUpdate
type: Property
domain: external_v1_environment
range: boolean

terminationProtection
type: Property
domain: external_v1_environment
range: boolean

createEphemeralOnPrCreate
type: Property
domain: external_v1_environment
range: boolean

destroyEphemeralOnPrClose
type: Property
domain: external_v1_environment
range: boolean

autoDeployEphemeral
type: Property
domain: external_v1_environment
range: boolean

primaryOptions
type: Property
domain: external_v1_environment

external_v1_environment_variable
type: Class
title: external_v1_environment_variable
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Environment variable name.
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: false
  description: Environment variable value.
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: false
  description: Environment variable marked as secret.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSecret
  title: isSecret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environment
  title: environment
  required: true
  readable: true
  writeable: true
supported operation: Retrieves external_v1_environment_variable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_environment_variable resource.
  returns: external_v1_environment_variable
supported operation: Updates the external_v1_environment_variable resource.
  type: Operation
  expects: external_v1_environment_variable
  method: PATCH
  title: Updates the external_v1_environment_variable resource.
  returns: external_v1_environment_variable
supported operation: Deletes the external_v1_environment_variable resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the external_v1_environment_variable resource.
  returns: Nothing
description: An environment variable used during Bunnyshell workflows.

entity
type: Link
domain: external_v1_environment_variable
max cardinality: 1
range: EnvironmentVariable

name
type: Property
domain: external_v1_environment_variable
range: string

value
type: Property
domain: external_v1_environment_variable
range: string

secret
type: Property
domain: external_v1_environment_variable
range: boolean

environment
type: Property
domain: external_v1_environment_variable
range: string

organization
type: Property
domain: external_v1_environment_variable

entityName
type: Property
domain: external_v1_environment_variable

entityClass
type: Property
domain: external_v1_environment_variable

isSecret
type: Property
domain: external_v1_environment_variable
range: boolean

external_v1_environ_item
type: Class
title: external_v1_environ_item
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: groupName
  title: groupName
  required: false
  readable: true
  writeable: false
  description: Environ group name.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Environment variable name.
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: false
  description: Environment variable value.
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: false
  description: Environment variable marked as secret.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: groupName
  title: groupName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSecret
  title: isSecret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environment
  title: environment
  required: true
  readable: true
  writeable: true
supported operation: Retrieves external_v1_environ_item resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_environ_item resource.
  returns: external_v1_environ_item
supported operation: Updates the external_v1_environ_item resource.
  type: Operation
  expects: external_v1_environ_item
  method: PATCH
  title: Updates the external_v1_environ_item resource.
  returns: external_v1_environ_item
supported operation: Deletes the external_v1_environ_item resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the external_v1_environ_item resource.
  returns: Nothing
description: An environment variable used during Bunnyshell workflows.

entity
type: Link
domain: external_v1_environ_item
max cardinality: 1
range: EnvironmentVariable

groupName
type: Property
domain: external_v1_environ_item
range: string

name
type: Property
domain: external_v1_environ_item
range: string

value
type: Property
domain: external_v1_environ_item
range: string

secret
type: Property
domain: external_v1_environ_item
range: boolean

environment
type: Property
domain: external_v1_environ_item
range: string

organization
type: Property
domain: external_v1_environ_item

entityName
type: Property
domain: external_v1_environ_item

entityClass
type: Property
domain: external_v1_environ_item

isSecret
type: Property
domain: external_v1_environ_item
range: boolean

external_v1_event
type: Class
title: external_v1_event
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
  description: Event type.
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: Event operation status.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
  description: Event creation time.
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
  description: Event last update time.
supported property: SupportedProperty
  property: delegated
  title: delegated
  required: false
  readable: true
  writeable: false
  description: Event identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_event resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_event resource.
  returns: external_v1_event
description: An event represents an operation on an environment, integration or settings

entity
type: Link
domain: external_v1_event
max cardinality: 1
range: Event

type
type: Property
domain: external_v1_event
range: string

status
type: Property
domain: external_v1_event
range: string

environment
type: Property
domain: external_v1_event

organization
type: Link
domain: external_v1_event

createdAt
type: Property
domain: external_v1_event
range: dateTime

updatedAt
type: Property
domain: external_v1_event
range: dateTime

delegated
type: Property
domain: external_v1_event

entityName
type: Property
domain: external_v1_event

entityClass
type: Property
domain: external_v1_event

external_v1_kubernetes_integration
type: Class
title: external_v1_kubernetes_integration
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterName
  title: clusterName
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration cluster name.
supported property: SupportedProperty
  property: cloudName
  title: cloudName
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration cloud name.
supported property: SupportedProperty
  property: cloudProvider
  title: cloudProvider
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration cluster provider.
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: Kubernetes integration status.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_kubernetes_integration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_kubernetes_integration resource.
  returns: external_v1_kubernetes_integration
description: A Kubernetes integration stores connection information for a Kubernetes cluster.

entity
type: Link
domain: external_v1_kubernetes_integration
max cardinality: 1
range: KubernetesIntegration

clusterName
type: Property
domain: external_v1_kubernetes_integration
range: string

cloudName
type: Property
domain: external_v1_kubernetes_integration
range: string

cloudProvider
type: Property
domain: external_v1_kubernetes_integration
range: string

status
type: Property
domain: external_v1_kubernetes_integration
range: string

organization
type: Property
domain: external_v1_kubernetes_integration
range: string

entityName
type: Property
domain: external_v1_kubernetes_integration

entityClass
type: Property
domain: external_v1_kubernetes_integration

external_v1_organization
type: Class
title: external_v1_organization
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Organization name as defined in Bunnyshell UI.
supported property: SupportedProperty
  property: timezone
  title: timezone
  required: false
  readable: true
  writeable: false
  description: Organization timezone as defined in Bunnyshell UI.
supported property: SupportedProperty
  property: totalUsers
  title: totalUsers
  required: false
  readable: true
  writeable: false
  description: Organization total users.
supported property: SupportedProperty
  property: totalProjects
  title: totalProjects
  required: false
  readable: true
  writeable: false
  description: Organization total projects.
supported property: SupportedProperty
  property: availableRegistries
  title: availableRegistries
  required: false
  readable: true
  writeable: false
  description: Organization total available registry integrations.
supported property: SupportedProperty
  property: availableClusters
  title: availableClusters
  required: false
  readable: true
  writeable: false
  description: Organization total available cluster integrations.
supported property: SupportedProperty
  property: availableGitIntegration
  title: availableGitIntegration
  required: false
  readable: true
  writeable: false
  description: Organization total available git integrations.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_organization resource.
  returns: external_v1_organization
description: An organization holds multiple projects and all the integrations used by environments

entity
type: Link
domain: external_v1_organization
max cardinality: 1
range: Organization

name
type: Property
domain: external_v1_organization
range: string

timezone
type: Property
domain: external_v1_organization
range: string

totalUsers
type: Property
domain: external_v1_organization

totalProjects
type: Property
domain: external_v1_organization

availableRegistries
type: Property
domain: external_v1_organization

availableClusters
type: Property
domain: external_v1_organization

availableGitIntegration
type: Property
domain: external_v1_organization

entityName
type: Property
domain: external_v1_organization

entityClass
type: Property
domain: external_v1_organization

external_v1_pipeline
type: Class
title: external_v1_pipeline
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
  description: Pipeline description.
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: Pipeline status.
supported property: SupportedProperty
  property: stages
  title: stages
  required: false
  readable: true
  writeable: false
  description: Stage identifier.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: event
  title: event
  required: false
  readable: true
  writeable: false
  description: Event identifier.
supported property: SupportedProperty
  property: webUrl
  title: webUrl
  required: false
  readable: true
  writeable: false
  description: Pipeline web URL.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_pipeline resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_pipeline resource.
  deprecated: true
  returns: external_v1_pipeline
description: A pipeline.
deprecated: true

entity
type: Link
domain: external_v1_pipeline
max cardinality: 1
range: Workflow

entityName
type: Property
domain: external_v1_pipeline

description
type: Property
domain: external_v1_pipeline
range: string

status
type: Property
domain: external_v1_pipeline
range: string

stages
type: Property
domain: external_v1_pipeline

environment
type: Property
domain: external_v1_pipeline

event
type: Property
domain: external_v1_pipeline

webUrl
type: Property
domain: external_v1_pipeline

organization
type: Property
domain: external_v1_pipeline

entityClass
type: Property
domain: external_v1_pipeline

external_v1_project
type: Class
title: external_v1_project
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: labels
  title: labels
  required: false
  readable: true
  writeable: false
  description: Environment labels.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Project name.
supported property: SupportedProperty
  property: totalEnvironments
  title: totalEnvironments
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: buildSettings
  title: buildSettings
  required: false
  readable: true
  writeable: false
  description: Project build settings.
supported property: SupportedProperty
  property: deploymentRunnerSettings
  title: deploymentRunnerSettings
  required: false
  readable: true
  writeable: false
  description: Project deploymentRunner settings.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: labels
  title: labels
  required: false
  readable: true
  writeable: true
supported operation: Retrieves external_v1_project resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_project resource.
  returns: external_v1_project
supported operation: Updates the external_v1_project resource.
  type: Operation
  expects: external_v1_project
  method: PATCH
  title: Updates the external_v1_project resource.
  returns: external_v1_project
supported operation: Updates the external_v1_project resource.
  type: Operation
  expects: external_v1_project
  method: PATCH
  title: Updates the external_v1_project resource.
  returns: external_v1_project
supported operation: Updates the external_v1_project resource.
  type: Operation
  expects: external_v1_project
  method: PATCH
  title: Updates the external_v1_project resource.
  returns: external_v1_project
supported operation: Deletes the external_v1_project resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the external_v1_project resource.
  returns: Nothing
description: A project holds multiple environments and shared secrets and settings.

entity
type: Link
domain: external_v1_project
max cardinality: 1
range: Project

labels
type: Property
domain: external_v1_project
range: string

name
type: Property
domain: external_v1_project
range: string

totalEnvironments
type: Property
domain: external_v1_project

buildSettings
type: Link
domain: external_v1_project

deploymentRunnerSettings
type: Link
domain: external_v1_project

organization
type: Property
domain: external_v1_project
range: string

entityName
type: Property
domain: external_v1_project

entityClass
type: Property
domain: external_v1_project

external_v1_project_variable
type: Class
title: external_v1_project_variable
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Project variable name.
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: false
  description: Project variable value.
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: false
  description: Project variable marked as secret.
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: false
  description: Project identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSecret
  title: isSecret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: project
  title: project
  required: true
  readable: true
  writeable: true
supported operation: Retrieves external_v1_project_variable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_project_variable resource.
  returns: external_v1_project_variable
supported operation: Updates the external_v1_project_variable resource.
  type: Operation
  expects: external_v1_project_variable
  method: PATCH
  title: Updates the external_v1_project_variable resource.
  returns: external_v1_project_variable
supported operation: Deletes the external_v1_project_variable resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the external_v1_project_variable resource.
  returns: Nothing
description: A project variable used during Bunnyshell workflows.

entity
type: Link
domain: external_v1_project_variable
max cardinality: 1
range: ProjectVariable

name
type: Property
domain: external_v1_project_variable
range: string

value
type: Property
domain: external_v1_project_variable
range: string

secret
type: Property
domain: external_v1_project_variable
range: boolean

project
type: Property
domain: external_v1_project_variable
range: string

organization
type: Property
domain: external_v1_project_variable

entityName
type: Property
domain: external_v1_project_variable

entityClass
type: Property
domain: external_v1_project_variable

isSecret
type: Property
domain: external_v1_project_variable
range: boolean

external_v1_registry_integration
type: Class
title: external_v1_registry_integration
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Registry integration name.
supported property: SupportedProperty
  property: providerName
  title: providerName
  required: false
  readable: true
  writeable: false
  description: Registry integration provider.
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: Registry integration status.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_registry_integration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_registry_integration resource.
  returns: external_v1_registry_integration
description: A Registry integration stores connection information for a Container registry.

entity
type: Link
domain: external_v1_registry_integration
max cardinality: 1
range: RegistryIntegration

name
type: Property
domain: external_v1_registry_integration
range: string

providerName
type: Property
domain: external_v1_registry_integration
range: string

status
type: Property
domain: external_v1_registry_integration
range: string

organization
type: Property
domain: external_v1_registry_integration

entityName
type: Property
domain: external_v1_registry_integration

entityClass
type: Property
domain: external_v1_registry_integration

external_v1_ssh
type: Class
title: external_v1_ssh
supported property: SupportedProperty
  property: componentSshHost
  title: componentSshHost
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: withSSHKeysFingerprints
  title: withSSHKeysFingerprints
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: component
  title: component
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: workspaceVMSSHCredentials
  title: workspaceVMSSHCredentials
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: hostname
  title: hostname
  required: false
  readable: true
  writeable: false
  description: The SSH domain.
supported property: SupportedProperty
  property: port
  title: port
  required: false
  readable: true
  writeable: false
  description: The SSH port.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
  description: The SSH username.
supported property: SupportedProperty
  property: sshKeyFingerprints
  title: sshKeyFingerprints
  required: false
  readable: true
  writeable: false
  description: The SSH keys fingerprints.
supported property: SupportedProperty
  property: userCanManageSSHKeys
  title: userCanManageSSHKeys
  required: false
  readable: true
  writeable: false
  description: If the user can manage SSH keys.
supported property: SupportedProperty
  property: environmentId
  title: environmentId
  required: false
  readable: true
  writeable: false
  description: The environment identifier.
supported property: SupportedProperty
  property: componentId
  title: componentId
  required: false
  readable: true
  writeable: false
  description: The service component identifier.
description: SSH

componentSshHost
type: Property
domain: external_v1_ssh
range: string

withSSHKeysFingerprints
type: Property
domain: external_v1_ssh
range: boolean

component
type: Property
domain: external_v1_ssh

workspaceVMSSHCredentials
type: Property
domain: external_v1_ssh

hostname
type: Property
domain: external_v1_ssh
range: string

port
type: Property
domain: external_v1_ssh
range: integer

user
type: Property
domain: external_v1_ssh
range: string

sshKeyFingerprints
type: Property
domain: external_v1_ssh
range: string

userCanManageSSHKeys
type: Property
domain: external_v1_ssh
range: boolean

environmentId
type: Property
domain: external_v1_ssh
range: string

componentId
type: Property
domain: external_v1_ssh
range: string

external_v1_secret
type: Class
title: external_v1_secret
supported property: SupportedProperty
  property: plainText
  title: plainText
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: expression
  title: expression
  required: false
  readable: true
  writeable: true
  description: Encrypted expression.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
  description: Organization identifier.
supported property: SupportedProperty
  property: expression
  title: expression
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainText
  title: plainText
  required: false
  readable: true
  writeable: true
  description: Plain text.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
  description: Organization identifier.
supported property: SupportedProperty
  property: yaml
  title: yaml
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mode
  title: mode
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
description: A secret is used to encrypt plain texts and decrypt cipher texts.

plainText
type: Property
domain: external_v1_secret
range: string

organization
type: Property
domain: external_v1_secret
range: string

expression
type: Property
domain: external_v1_secret
range: string

yaml
type: Property
domain: external_v1_secret
range: string

mode
type: Property
domain: external_v1_secret
range: string

external_v1_componentEndpoint
type: Class
title: external_v1_componentEndpoint
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Service component name
supported property: SupportedProperty
  property: endpoints
  title: endpoints
  required: false
  readable: true
  writeable: false
  description: Service component URLs
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_componentEndpoint resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_componentEndpoint resource.
  returns: external_v1_componentEndpoint
description: Endpoint

entity
type: Property
domain: external_v1_componentEndpoint

name
type: Property
domain: external_v1_componentEndpoint
range: string

endpoints
type: Property
domain: external_v1_componentEndpoint
range: string

environment
type: Property
domain: external_v1_componentEndpoint

entityName
type: Property
domain: external_v1_componentEndpoint

entityClass
type: Property
domain: external_v1_componentEndpoint

external_v1_componentGit
type: Class
title: external_v1_componentGit
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Service component name
supported property: SupportedProperty
  property: repository
  title: repository
  required: false
  readable: true
  writeable: false
  description: Git repository
supported property: SupportedProperty
  property: refName
  title: refName
  required: false
  readable: true
  writeable: false
  description: Git ref name
supported property: SupportedProperty
  property: path
  title: path
  required: false
  readable: true
  writeable: false
  description: Git application path
supported property: SupportedProperty
  property: refSha
  title: refSha
  required: false
  readable: true
  writeable: false
  description: Git ref sha
supported property: SupportedProperty
  property: deployedSha
  title: deployedSha
  required: false
  readable: true
  writeable: false
  description: Git deployed sha
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_componentGit resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_componentGit resource.
  returns: external_v1_componentGit
description: Git info

entity
type: Property
domain: external_v1_componentGit

name
type: Property
domain: external_v1_componentGit
range: string

repository
type: Property
domain: external_v1_componentGit
range: string

refName
type: Property
domain: external_v1_componentGit
range: string

path
type: Property
domain: external_v1_componentGit
range: string

refSha
type: Property
domain: external_v1_componentGit
range: string

deployedSha
type: Property
domain: external_v1_componentGit
range: string

environment
type: Property
domain: external_v1_componentGit

entityName
type: Property
domain: external_v1_componentGit

entityClass
type: Property
domain: external_v1_componentGit

external_v1_component
type: Class
title: external_v1_component
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Service component name
supported property: SupportedProperty
  property: clusterStatus
  title: clusterStatus
  required: false
  readable: true
  writeable: false
  description: Service component cluster status
supported property: SupportedProperty
  property: operationStatus
  title: operationStatus
  required: false
  readable: true
  writeable: false
  description: Service component operation status
supported property: SupportedProperty
  property: publicURLs
  title: publicURLs
  required: false
  readable: true
  writeable: false
  description: Service component URLs
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_component resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_component resource.
  returns: external_v1_component
supported operation: Retrieves external_v1_component resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_component resource.
  returns: external_v1_component
supported operation: Retrieves external_v1_component resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_component resource.
  returns: external_v1_component
supported operation: Creates a external_v1_component resource.
  type: Operation
  type: CreateAction
  expects: external_v1_component
  method: POST
  title: Creates a external_v1_component resource.
  returns: external_v1_component
supported operation: Retrieves external_v1_component resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_component resource.
  returns: external_v1_component
supported operation: Creates a external_v1_component resource.
  type: Operation
  type: CreateAction
  expects: external_v1_component
  method: POST
  title: Creates a external_v1_component resource.
  returns: external_v1_component
description: A service component represents either an application or a group of applications as a single unit

entity
type: Property
domain: external_v1_component

name
type: Property
domain: external_v1_component
range: string

clusterStatus
type: Property
domain: external_v1_component
range: string

operationStatus
type: Property
domain: external_v1_component
range: string

publicURLs
type: Property
domain: external_v1_component
range: string

environment
type: Property
domain: external_v1_component

entityName
type: Property
domain: external_v1_component

entityClass
type: Property
domain: external_v1_component

external_v1_service_component_variable
type: Class
title: external_v1_service_component_variable
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Component variable name.
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: false
  description: Component variable value.
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: false
  description: Component variable marked as secret.
supported property: SupportedProperty
  property: serviceComponent
  title: serviceComponent
  required: false
  readable: true
  writeable: false
  description: Service component identifier
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: false
  description: Project identifier.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSecret
  title: isSecret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: serviceComponent
  title: serviceComponent
  required: true
  readable: true
  writeable: true
supported operation: Retrieves external_v1_service_component_variable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_service_component_variable resource.
  returns: external_v1_service_component_variable
supported operation: Updates the external_v1_service_component_variable resource.
  type: Operation
  expects: external_v1_service_component_variable
  method: PATCH
  title: Updates the external_v1_service_component_variable resource.
  returns: external_v1_service_component_variable
supported operation: Deletes the external_v1_service_component_variable resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the external_v1_service_component_variable resource.
  returns: Nothing
description: A component variable used during Bunnyshell workflows.

entity
type: Link
domain: external_v1_service_component_variable
max cardinality: 1
range: ServiceComponentVariable

name
type: Property
domain: external_v1_service_component_variable
range: string

value
type: Property
domain: external_v1_service_component_variable
range: string

secret
type: Property
domain: external_v1_service_component_variable
range: boolean

serviceComponent
type: Property
domain: external_v1_service_component_variable
range: string

project
type: Property
domain: external_v1_service_component_variable

environment
type: Property
domain: external_v1_service_component_variable

organization
type: Property
domain: external_v1_service_component_variable

entityName
type: Property
domain: external_v1_service_component_variable

entityClass
type: Property
domain: external_v1_service_component_variable

isSecret
type: Property
domain: external_v1_service_component_variable
range: boolean

external_v1_template
type: Class
title: external_v1_template
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: key
  title: key
  required: false
  readable: true
  writeable: false
  description: Template key.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Template name.
supported property: SupportedProperty
  property: gitSha
  title: gitSha
  required: false
  readable: true
  writeable: false
  description: Template git repository SHA.
supported property: SupportedProperty
  property: shortDescription
  title: shortDescription
  required: false
  readable: true
  writeable: false
  description: Template short description.
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: false
  description: Template tags.
supported property: SupportedProperty
  property: variablesSchema
  title: variablesSchema
  required: false
  readable: true
  writeable: false
  description: Template variables.
supported property: SupportedProperty
  property: bunnyshellYaml
  title: bunnyshellYaml
  required: false
  readable: true
  writeable: false
  description: The Environment definition.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: templatesRepository
  title: templatesRepository
  required: false
  readable: true
  writeable: false
  description: Templates repository identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: source
  title: source
  required: false
  readable: true
  writeable: true
supported operation: Retrieves external_v1_template resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_template resource.
  returns: external_v1_template
supported operation: Retrieves external_v1_template resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_template resource.
  returns: external_v1_template
description: A template holds information for generating an environment.

entity
type: Link
domain: external_v1_template
max cardinality: 1
range: Template

key
type: Property
domain: external_v1_template
range: string

name
type: Property
domain: external_v1_template
range: string

gitSha
type: Property
domain: external_v1_template
range: string

shortDescription
type: Property
domain: external_v1_template
range: string

tags
type: Property
domain: external_v1_template
range: string

variablesSchema
type: Property
domain: external_v1_template

bunnyshellYaml
type: Property
domain: external_v1_template
range: string

organization
type: Property
domain: external_v1_template

templatesRepository
type: Property
domain: external_v1_template

entityName
type: Property
domain: external_v1_template

entityClass
type: Property
domain: external_v1_template

source
type: Property
domain: external_v1_template

external_v1_templates_repository
type: Class
title: external_v1_templates_repository
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: Templates repository name.
supported property: SupportedProperty
  property: gitRepositoryUrl
  title: gitRepositoryUrl
  required: false
  readable: true
  writeable: false
  description: Templates repository git repository URL.
supported property: SupportedProperty
  property: gitRef
  title: gitRef
  required: false
  readable: true
  writeable: false
  description: Templates repository git repository reference.
supported property: SupportedProperty
  property: lastSyncSha
  title: lastSyncSha
  required: false
  readable: true
  writeable: false
  description: Templates repository last synced git repository SHA.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_templates_repository resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_templates_repository resource.
  returns: external_v1_templates_repository
description: A templates repository holds multiple templates.

entity
type: Link
domain: external_v1_templates_repository
max cardinality: 1
range: TemplatesRepository

name
type: Property
domain: external_v1_templates_repository
range: string

gitRepositoryUrl
type: Property
domain: external_v1_templates_repository
range: string

gitRef
type: Property
domain: external_v1_templates_repository
range: string

lastSyncSha
type: Property
domain: external_v1_templates_repository
range: string

organization
type: Property
domain: external_v1_templates_repository

entityName
type: Property
domain: external_v1_templates_repository

entityClass
type: Property
domain: external_v1_templates_repository

external_v1_workflow
type: Class
title: external_v1_workflow
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
  description: Workflow description.
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: Workflow status.
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
  description: Environment identifier.
supported property: SupportedProperty
  property: event
  title: event
  required: false
  readable: true
  writeable: false
  description: Event identifier.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: Organization identifier.
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
  description: Workflow duration in seconds.
supported property: SupportedProperty
  property: jobsCount
  title: jobsCount
  required: false
  readable: true
  writeable: false
  description: Number of jobs.
supported property: SupportedProperty
  property: completedJobsCount
  title: completedJobsCount
  required: false
  readable: true
  writeable: false
  description: Number of completed jobs.
supported property: SupportedProperty
  property: webUrl
  title: webUrl
  required: false
  readable: true
  writeable: false
  description: Workflow web URL.
supported property: SupportedProperty
  property: entityName
  title: entityName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entityClass
  title: entityClass
  required: false
  readable: true
  writeable: false
supported operation: Retrieves external_v1_workflow resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves external_v1_workflow resource.
  returns: external_v1_workflow
description: A workflow.

entity
type: Link
domain: external_v1_workflow
max cardinality: 1
range: Workflow

description
type: Property
domain: external_v1_workflow
range: string

status
type: Property
domain: external_v1_workflow
range: string

environment
type: Property
domain: external_v1_workflow

event
type: Property
domain: external_v1_workflow

organization
type: Property
domain: external_v1_workflow

duration
type: Property
domain: external_v1_workflow
range: integer

jobsCount
type: Property
domain: external_v1_workflow

completedJobsCount
type: Property
domain: external_v1_workflow

webUrl
type: Property
domain: external_v1_workflow

entityName
type: Property
domain: external_v1_workflow

entityClass
type: Property
domain: external_v1_workflow

Addon
type: Class
title: Addon

Application
type: Class
title: Application
supported operation: Retrieves Application resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Application resource.
  deprecated: true
  returns: Nothing

ApplyConfigurationJob
type: Class
title: ApplyConfigurationJob
supported operation: Retrieves ApplyConfigurationJob resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ApplyConfigurationJob resource.
  deprecated: true
  returns: Nothing

BillingProduct
type: Class
title: BillingProduct
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stripeId
  title: stripeId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: prices
  title: prices
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isAddon
  title: isAddon
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isFlat
  title: isFlat
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaUsers
  title: quotaUsers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaNamespaces
  title: quotaNamespaces
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaPods
  title: quotaPods
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaCPU
  title: quotaCPU
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaMemory
  title: quotaMemory
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaStorage
  title: quotaStorage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaDeployments
  title: quotaDeployments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureStaging
  title: hasFeatureStaging
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureProduction
  title: hasFeatureProduction
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureAPI
  title: hasFeatureAPI
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeaturePrivateRegistry
  title: hasFeaturePrivateRegistry
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureAvailabilityRules
  title: hasFeatureAvailabilityRules
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureWorkers
  title: hasFeatureWorkers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureRemoteDev
  title: hasFeatureRemoteDev
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureBuiltinBuildSystem
  title: hasFeatureBuiltinBuildSystem
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureEphemerals
  title: hasFeatureEphemerals
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceRON
  title: priceRON
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceUSD
  title: priceUSD
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaUsers
  title: quotaUsers
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaNamespaces
  title: quotaNamespaces
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaPods
  title: quotaPods
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaMemory
  title: quotaMemory
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaStorage
  title: quotaStorage
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaCPU
  title: quotaCPU
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: quotaDeployments
  title: quotaDeployments
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasFeatureAPI
  title: hasFeatureAPI
  required: false
  readable: true
  writeable: true
supported operation: Retrieves BillingProduct resource.

slug
type: Property
domain: BillingProduct
range: string

name
type: Property
domain: BillingProduct
range: string

stripeId
type: Property
domain: BillingProduct
range: string

prices
type: Property
domain: BillingProduct

isAddon
type: Property
domain: BillingProduct
range: boolean

isFlat
type: Property
domain: BillingProduct
range: boolean

quotaUsers
type: Property
domain: BillingProduct
range: integer

quotaNamespaces
type: Property
domain: BillingProduct
range: integer

quotaPods
type: Property
domain: BillingProduct
range: integer

quotaCPU
type: Property
domain: BillingProduct
range: integer

quotaMemory
type: Property
domain: BillingProduct
range: integer

quotaStorage
type: Property
domain: BillingProduct
range: integer

quotaDeployments
type: Property
domain: BillingProduct
range: integer

hasFeatureStaging
type: Property
domain: BillingProduct
range: boolean

hasFeatureProduction
type: Property
domain: BillingProduct
range: boolean

hasFeatureAPI
type: Property
domain: BillingProduct
range: boolean

hasFeaturePrivateRegistry
type: Property
domain: BillingProduct
range: boolean

hasFeatureAvailabilityRules
type: Property
domain: BillingProduct
range: boolean

hasFeatureWorkers
type: Property
domain: BillingProduct
range: boolean

hasFeatureRemoteDev
type: Property
domain: BillingProduct
range: boolean

hasFeatureBuiltinBuildSystem
type: Property
domain: BillingProduct
range: boolean

hasFeatureEphemerals
type: Property
domain: BillingProduct

priceRON
type: Property
domain: BillingProduct
range: integer

priceUSD
type: Property
domain: BillingProduct
range: integer

hasFeatureEphemeral
type: Property
domain: BillingProduct
range: boolean

BillingProfile
type: Class
title: BillingProfile
supported property: SupportedProperty
  property: coupon
  title: coupon
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: address
  title: address
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: vatCode
  title: vatCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isVatVerified
  title: isVatVerified
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isVatPending
  title: isVatPending
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isFailedPayment
  title: isFailedPayment
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: hasEmailTrialEndSoon
  title: hasEmailTrialEndSoon
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasEmailTrialEnded
  title: hasEmailTrialEnded
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasEmailGoodbye
  title: hasEmailGoodbye
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stripeCustomerId
  title: stripeCustomerId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stripeSubscriptionId
  title: stripeSubscriptionId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stripeCoupon
  title: stripeCoupon
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isSubscriptionInactive
  title: isSubscriptionInactive
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentPeriodEnd
  title: currentPeriodEnd
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: trialStarted
  title: trialStarted
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: trialEnd
  title: trialEnd
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cancelAtPeriod
  title: cancelAtPeriod
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaUsers
  title: quotaUsers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaNamespaces
  title: quotaNamespaces
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaPods
  title: quotaPods
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaCPU
  title: quotaCPU
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaMemory
  title: quotaMemory
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaStorage
  title: quotaStorage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: quotaDeployments
  title: quotaDeployments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureStaging
  title: hasFeatureStaging
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureProduction
  title: hasFeatureProduction
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureAPI
  title: hasFeatureAPI
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeaturePrivateRegistry
  title: hasFeaturePrivateRegistry
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureAvailabilityRules
  title: hasFeatureAvailabilityRules
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasFeatureWorkers
  title: hasFeatureWorkers
  required: false
  readable: true
  writeable: false
supported operation: Retrieves BillingProfile resource.
supported operation: Deletes the BillingProfile resource.
supported operation: Creates a BillingProfile resource.
description: BillingProfile class

coupon
type: Property
domain: BillingProfile
range: string

name
type: Property
domain: BillingProfile
range: string

country
type: Property
domain: BillingProfile
range: string

address
type: Property
domain: BillingProfile
range: string

vatCode
type: Property
domain: BillingProfile
range: string

isVatVerified
type: Property
domain: BillingProfile
range: boolean

isVatPending
type: Property
domain: BillingProfile
range: boolean

isFailedPayment
type: Property
domain: BillingProfile
range: boolean

hasEmailTrialEndSoon
type: Property
domain: BillingProfile
range: boolean

hasEmailTrialEnded
type: Property
domain: BillingProfile
range: boolean

hasEmailGoodbye
type: Property
domain: BillingProfile
range: boolean

email
type: Property
domain: BillingProfile
range: string

stripeCustomerId
type: Property
domain: BillingProfile
range: string

stripeSubscriptionId
type: Property
domain: BillingProfile
range: string

stripeCoupon
type: Property
domain: BillingProfile
range: string

isSubscriptionInactive
type: Property
domain: BillingProfile
range: boolean

currentPeriodEnd
type: Property
domain: BillingProfile
range: dateTime

trialStarted
type: Property
domain: BillingProfile
range: dateTime

trialEnd
type: Property
domain: BillingProfile
range: dateTime

cancelAtPeriod
type: Property
domain: BillingProfile
range: boolean

quotaUsers
type: Property
domain: BillingProfile
range: integer

quotaNamespaces
type: Property
domain: BillingProfile
range: integer

quotaPods
type: Property
domain: BillingProfile
range: integer

quotaCPU
type: Property
domain: BillingProfile
range: integer

quotaMemory
type: Property
domain: BillingProfile
range: integer

quotaStorage
type: Property
domain: BillingProfile
range: integer

quotaDeployments
type: Property
domain: BillingProfile
range: integer

hasFeatureStaging
type: Property
domain: BillingProfile
range: boolean

hasFeatureProduction
type: Property
domain: BillingProfile
range: boolean

hasFeatureAPI
type: Property
domain: BillingProfile
range: boolean

hasFeaturePrivateRegistry
type: Property
domain: BillingProfile
range: boolean

hasFeatureAvailabilityRules
type: Property
domain: BillingProfile
range: boolean

hasFeatureWorkers
type: Property
domain: BillingProfile
range: boolean

hasFeatureRemoteDev
type: Property
domain: BillingProfile
range: boolean

hasFeatureBuiltinBuildSystem
type: Property
domain: BillingProfile
range: boolean

stripeProductIds
type: Property
domain: BillingProfile

stripePriceIds
type: Property
domain: BillingProfile

hasFeatureEphemerals
type: Property
domain: BillingProfile

BunnyshellVolumesAddon
type: Class
title: BunnyshellVolumesAddon
supported property: SupportedProperty
  property: addonConfiguration
  title: addonConfiguration
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRemovable
  title: isRemovable
  required: false
  readable: false
  writeable: false
supported operation: Retrieves BunnyshellVolumesAddon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves BunnyshellVolumesAddon resource.
  returns: BunnyshellVolumesAddon
supported operation: Replaces the BunnyshellVolumesAddon resource.
  type: Operation
  type: ReplaceAction
  expects: BunnyshellVolumesAddon
  method: PUT
  title: Replaces the BunnyshellVolumesAddon resource.
  returns: BunnyshellVolumesAddon
supported operation: Deletes the BunnyshellVolumesAddon resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the BunnyshellVolumesAddon resource.
  returns: Nothing

addonConfiguration
type: Property
domain: BunnyshellVolumesAddon

enabled
type: Property
domain: BunnyshellVolumesAddon
range: boolean

type
type: Property
domain: BunnyshellVolumesAddon
range: string

status
type: Property
domain: BunnyshellVolumesAddon
range: string

kubernetesIntegration
type: Link
domain: BunnyshellVolumesAddon
max cardinality: 1
range: KubernetesIntegration

isRemovable
type: Property
domain: BunnyshellVolumesAddon

CloudProvider
type: Class
title: CloudProvider
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: true
  readable: true
  writeable: true
supported operation: Retrieves CloudProvider resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CloudProvider resource.
  returns: CloudProvider

name
type: Property
domain: CloudProvider
range: string

slug
type: Property
domain: CloudProvider
range: string

CostTrackingAddon
type: Class
title: CostTrackingAddon
supported property: SupportedProperty
  property: costTrackingDataErrorAt
  title: costTrackingDataErrorAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: addonConfiguration
  title: addonConfiguration
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: costTrackingDataSuspended
  title: costTrackingDataSuspended
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRemovable
  title: isRemovable
  required: false
  readable: false
  writeable: false
supported operation: Retrieves CostTrackingAddon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CostTrackingAddon resource.
  returns: CostTrackingAddon
supported operation: Replaces the CostTrackingAddon resource.
  type: Operation
  type: ReplaceAction
  expects: CostTrackingAddon
  method: PUT
  title: Replaces the CostTrackingAddon resource.
  returns: CostTrackingAddon
supported operation: Deletes the CostTrackingAddon resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the CostTrackingAddon resource.
  returns: Nothing

costTrackingDataErrorAt
type: Property
domain: CostTrackingAddon
range: dateTime

addonConfiguration
type: Property
domain: CostTrackingAddon

costTrackingDataSuspended
type: Property
domain: CostTrackingAddon
range: boolean

enabled
type: Property
domain: CostTrackingAddon
range: boolean

type
type: Property
domain: CostTrackingAddon
range: string

status
type: Property
domain: CostTrackingAddon
range: string

kubernetesIntegration
type: Link
domain: CostTrackingAddon
max cardinality: 1
range: KubernetesIntegration

isRemovable
type: Property
domain: CostTrackingAddon

CustomDockerImageComponent
type: Class
title: CustomDockerImageComponent
supported operation: Retrieves CustomDockerImageComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CustomDockerImageComponent resource.
  deprecated: true
  returns: Nothing

Database
type: Class
title: Database
supported operation: Retrieves Database resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Database resource.
  deprecated: true
  returns: Nothing

DockerImageComponent
type: Class
title: DockerImageComponent
supported operation: Retrieves DockerImageComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves DockerImageComponent resource.
  deprecated: true
  returns: Nothing

Environment
type: Class
title: Environment
supported property: SupportedProperty
  property: unique
  title: unique
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: autoUpdate
  title: autoUpdate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: remoteDevelopmentAllowed
  title: remoteDevelopmentAllowed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: operationStatus
  title: operationStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: clusterStatus
  title: clusterStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: expiryIntervalSeconds
  title: expiryIntervalSeconds
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: urlHandle
  title: urlHandle
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hostingRegion
  title: hostingRegion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: terminationProtection
  title: terminationProtection
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: buildSettings
  title: buildSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deploymentRunnerSettings
  title: deploymentRunnerSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ephemeralSettings
  title: ephemeralSettings
  required: false
  readable: true
  writeable: false
  description: It's a One-To-One in disguise; if we use One-To-One the fetch=EXTRA_LAZY does not work
supported property: SupportedProperty
  property: templateSettings
  title: templateSettings
  required: false
  readable: true
  writeable: false
  description: It's a One-To-One in disguise; if we use One-To-One the fetch=EXTRA_LAZY does not work
supported property: SupportedProperty
  property: workflowSettings
  title: workflowSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: labels
  title: labels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: parentId
  title: parentId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: expirationDate
  title: expirationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasDraftComponents
  title: hasDraftComponents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasEnvironmentVariables
  title: hasEnvironmentVariables
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasDraftEnvironmentVariables
  title: hasDraftEnvironmentVariables
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: displayableComponentsCount
  title: displayableComponentsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: displayableDraftComponentsCount
  title: displayableDraftComponentsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasComponents
  title: hasComponents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: templateDetails
  title: templateDetails
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Environment resource.
supported operation: Replaces the Environment resource.
supported operation: Creates a Environment resource.
supported operation: Deletes the Environment resource.
supported operation: Retrieves the collection of EnvironmentVariable resources.
supported operation: Retrieves the collection of EnvironmentTimeframe resources.

unique
type: Property
domain: Environment
range: string

name
type: Property
domain: Environment
range: string

type
type: Property
domain: Environment
range: string

autoUpdate
type: Property
domain: Environment
range: boolean

remoteDevelopmentAllowed
type: Property
domain: Environment
range: boolean

operationStatus
type: Property
domain: Environment
range: string

clusterStatus
type: Property
domain: Environment
range: string

status
type: Property
domain: Environment
range: string

expiryIntervalSeconds
type: Property
domain: Environment
range: integer

project
type: Link
domain: Environment
max cardinality: 1
range: Project

urlHandle
type: Property
domain: Environment

kubernetesIntegration
type: Property
domain: Environment
max cardinality: 1
range: KubernetesIntegration

hostingRegion
type: Property
domain: Environment
range: string

terminationProtection
type: Property
domain: Environment
range: boolean

createdAt
type: Property
domain: Environment
range: dateTime

updatedAt
type: Property
domain: Environment
range: dateTime

createdBy
type: Link
domain: Environment
max cardinality: 1
range: User

buildSettings
type: Property
domain: Environment

deploymentRunnerSettings
type: Property
domain: Environment

ephemeralSettings
type: Property
domain: Environment

templateSettings
type: Property
domain: Environment

workflowSettings
type: Property
domain: Environment

labels
type: Property
domain: Environment
range: string

organization
type: Link
domain: Environment
max cardinality: 1
range: Organization

parentId
type: Property
domain: Environment
range: string

expirationDate
type: Property
domain: Environment
range: dateTime

hasDraftComponents
type: Property
domain: Environment
range: boolean

hasEnvironmentVariables
type: Property
domain: Environment
range: boolean

hasDraftEnvironmentVariables
type: Property
domain: Environment
range: boolean

displayableComponentsCount
type: Property
domain: Environment
range: integer

displayableDraftComponentsCount
type: Property
domain: Environment
range: integer

hasComponents
type: Property
domain: Environment
range: boolean

templateDetails
type: Property
domain: Environment

componentsSyncStatus
type: Property
domain: Environment
range: string

hasMarkedForDeletionContent
type: Property
domain: Environment
range: boolean

ephemeralKubernetesIntegration
type: Property
domain: Environment
max cardinality: 1
range: KubernetesIntegration

ephemeralHostingRegion
type: Property
domain: Environment
range: string

createEphemeralOnPrCreate
type: Property
domain: Environment
range: boolean

autoDeployEphemeral
type: Property
domain: Environment
range: boolean

destroyEphemeralOnPrClose
type: Property
domain: Environment
range: boolean

publicId
type: Property
domain: Environment

aggregatedOperationStatus
type: Property
domain: Environment

hasDraft
type: Property
domain: Environment

createdByUser
type: Property
domain: Environment

environmentVariables
type: Property
domain: Environment
range: EnvironmentVariable

timeframes
type: Property
domain: Environment
range: EnvironmentTimeframe

EnvironmentTimeframe
type: Class
title: EnvironmentTimeframe
supported property: SupportedProperty
  property: environment
  title: environment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeframe
  title: timeframe
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startHour
  title: startHour
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endHour
  title: endHour
  required: false
  readable: true
  writeable: true
supported operation: Retrieves EnvironmentTimeframe resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves EnvironmentTimeframe resource.
  returns: EnvironmentTimeframe
supported operation: Deletes the EnvironmentTimeframe resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the EnvironmentTimeframe resource.
  returns: Nothing

environment
type: Link
domain: EnvironmentTimeframe
max cardinality: 1
range: Environment

timeframe
type: Property
domain: EnvironmentTimeframe
max cardinality: 1
range: Timeframe

startHour
type: Property
domain: EnvironmentTimeframe
range: dateTime

endHour
type: Property
domain: EnvironmentTimeframe
range: dateTime

EnvironmentVariable
type: Class
title: EnvironmentVariable
supported operation: Retrieves EnvironmentVariable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves EnvironmentVariable resource.
  returns: EnvironmentVariable

Event
type: Class
title: Event
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deploymentJobs
  title: deploymentJobs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasLogs
  title: hasLogs
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Event resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Event resource.
  returns: Event

organization
type: Link
domain: Event
max cardinality: 1
range: Organization

environment
type: Link
domain: Event
max cardinality: 1
range: Environment

type
type: Property
domain: Event
range: string

user
type: Property
domain: Event
max cardinality: 1
range: User

description
type: Property
domain: Event
range: string

status
type: Property
domain: Event
range: string

deploymentJobs
type: Property
domain: Event

createdAt
type: Property
domain: Event
range: dateTime

updatedAt
type: Property
domain: Event
range: dateTime

hasLogs
type: Property
domain: Event
range: boolean

GenericComponent
type: Class
title: GenericComponent
supported operation: Retrieves GenericComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GenericComponent resource.
  deprecated: true
  returns: Nothing

GitIntegration
type: Class
title: GitIntegration
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
  description: The type of the provider
supported property: SupportedProperty
  property: isGithubApp
  title: isGithubApp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
  description: TODO: cleanup when ND-4825 is not needed
supported property: SupportedProperty
  property: provider
  title: provider
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ephemeralOptions
  title: ephemeralOptions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: installationId
  title: installationId
  required: false
  readable: true
  writeable: false
  description: For Github, GithubApp variant
supported property: SupportedProperty
  property: accountType
  title: accountType
  required: false
  readable: true
  writeable: false
  description: For Github, GithubApp variant user or organization, we need this to be able to form the installation url accountType=organization => https://github.com/organizations/{slug}/settings/installations/{installationId} accountType=user => https://github.com/settings/installations/{installationId}
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: stateCode
  title: stateCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: githubConfigUrl
  title: githubConfigUrl
  required: false
  readable: true
  writeable: false
  description: ! This is overwritten in GitIntegrationNormalizer, because Github non-owners cannot access the installation settings page (https://github.com/organizations/%s/settings/installations/%s), instead of sending them to a 404 page in Github, we will send them to the installation page, where they can choose an organization and continue with request adding a repo, request uninstalling the app If we would know the user who click Configure/Remove in Bunnyshell is the owner of the Org in Github, then this function would be better
supported property: SupportedProperty
  property: gitRepositories
  title: gitRepositories
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: providerId
  title: providerId
  required: false
  readable: true
  writeable: true
  description: Provider id is set and mandatory only for private git connections
supported property: SupportedProperty
  property: exchangeCode
  title: exchangeCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: stateCode
  title: stateCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: installationId
  title: installationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
  description: Type is mandatory for all types of integrations
supported operation: Retrieves GitIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GitIntegration resource.
  returns: GitIntegration
supported operation: Replaces the GitIntegration resource.
  type: Operation
  type: ReplaceAction
  expects: GitIntegration
  method: PUT
  title: Replaces the GitIntegration resource.
  returns: GitIntegration
supported operation: Retrieves GitIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GitIntegration resource.
  returns: GitIntegration
supported operation: Deletes the GitIntegration resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the GitIntegration resource.
  returns: Nothing
supported operation: Creates a GitIntegration resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a GitIntegration resource.
  returns: GitIntegration
supported operation: Retrieves the collection of GitRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitRepository resources.
  returns: GitRepository

organizationId
type: Property
domain: GitIntegration
range: integer

type
type: Property
domain: GitIntegration
range: string

isGithubApp
type: Property
domain: GitIntegration
range: boolean

organization
type: Link
domain: GitIntegration
max cardinality: 1
range: Organization

provider
type: Property
domain: GitIntegration
max cardinality: 1
range: GitProvider

ephemeralOptions
type: Property
domain: GitIntegration

installationId
type: Property
domain: GitIntegration
range: string
range: integer

accountType
type: Property
domain: GitIntegration
range: string

slug
type: Property
domain: GitIntegration
range: string

stateCode
type: Property
domain: GitIntegration
range: string

status
type: Property
domain: GitIntegration
range: string

githubConfigUrl
type: Property
domain: GitIntegration
range: string

gitRepositories
type: Property
domain: GitIntegration
range: GitRepository

providerId
type: Property
domain: GitIntegration
range: integer

exchangeCode
type: Property
domain: GitIntegration
range: string

GitProvider
type: Class
title: GitProvider
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: providerName
  title: providerName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: apiBaseUrl
  title: apiBaseUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: oauthBaseUrl
  title: oauthBaseUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: oauthClientId
  title: oauthClientId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: oauthClientSecret
  title: oauthClientSecret
  required: false
  readable: true
  writeable: true
supported operation: Retrieves GitProvider resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GitProvider resource.
  returns: GitProvider
supported operation: Replaces the GitProvider resource.
  type: Operation
  type: ReplaceAction
  expects: GitProvider
  method: PUT
  title: Replaces the GitProvider resource.
  returns: GitProvider

type
type: Property
domain: GitProvider
range: string

providerName
type: Property
domain: GitProvider
range: string

organization
type: Link
domain: GitProvider
max cardinality: 1
range: Organization

apiBaseUrl
type: Property
domain: GitProvider
range: string

oauthBaseUrl
type: Property
domain: GitProvider
range: string

oauthClientId
type: Property
domain: GitProvider
range: string

oauthClientSecret
type: Property
domain: GitProvider
range: string

GitRepository
type: Class
title: GitRepository
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
  description: TODO: cleanup when ND-4825 is not needed
supported property: SupportedProperty
  property: provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: integration
  title: integration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ownerSlug
  title: ownerSlug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloneUrl
  title: cloneUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasAccountWebhookAccess
  title: hasAccountWebhookAccess
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasAccountPullAccess
  title: hasAccountPullAccess
  required: false
  readable: true
  writeable: true
supported operation: Retrieves GitRepository resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GitRepository resource.
  returns: GitRepository

organization
type: Link
domain: GitRepository
max cardinality: 1
range: Organization

provider
type: Link
domain: GitRepository
max cardinality: 1
range: GitProvider

integration
type: Link
domain: GitRepository
max cardinality: 1
range: GitIntegration

ownerSlug
type: Property
domain: GitRepository
range: string

name
type: Property
domain: GitRepository
range: string

cloneUrl
type: Property
domain: GitRepository
range: string

status
type: Property
domain: GitRepository
range: string

hasAccountWebhookAccess
type: Property
domain: GitRepository
range: boolean

hasAccountPullAccess
type: Property
domain: GitRepository
range: boolean

GoldenImage
type: Class
title: GoldenImage
supported property: SupportedProperty
  property: slug
  title: slug
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: version
  title: version
  required: true
  readable: true
  writeable: true
  description: Technical, not exposed to user, but for us to be able to make updates on the images, while keeping the same slug for user
supported property: SupportedProperty
  property: current
  title: current
  required: false
  readable: true
  writeable: true
  description: Technical, not exposed to user, but for us to be able to make updates on the images, while keeping the same slug for user, only one version of a slug can be enabled !! To benefit from unique_index, we use NULL for false value
supported property: SupportedProperty
  property: diskSize
  title: diskSize
  required: true
  readable: true
  writeable: true
  description: We validate that the root disk for a WorkspaceVM to not have less than this
supported property: SupportedProperty
  property: osArch
  title: osArch
  required: true
  readable: true
  writeable: true
  description: For the moment, just for the record, maybe in future when we will support many os arches.
supported property: SupportedProperty
  property: osName
  title: osName
  required: true
  readable: true
  writeable: true
  description: For the moment, just for the record, maybe in future when we will make a listing and filtering, "I want to be an Ubuntu"
supported property: SupportedProperty
  property: osVersion
  title: osVersion
  required: true
  readable: true
  writeable: true
  description: For the moment, just for the record, maybe in future when we will make a listing and filtering, "I want to be an Ubuntu, 20"
supported property: SupportedProperty
  property: defaultShell
  title: defaultShell
  required: true
  readable: true
  writeable: true
  description: We will create the bunnyshell user to use this shell, so when the user SSH into VM will use this shell
supported property: SupportedProperty
  property: preinstalledPackages
  title: preinstalledPackages
  required: false
  readable: true
  writeable: true
  description: For the moment, just for the record, maybe in future when we will make a listing and filtering, "I want to be an Ubuntu, and have php and docker, what golden images do you have with these"
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: Just a description, will be displayed in UI when user choose it
supported operation: Retrieves GoldenImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GoldenImage resource.
  returns: GoldenImage

slug
type: Property
domain: GoldenImage
range: string

version
type: Property
domain: GoldenImage
range: string

current
type: Property
domain: GoldenImage
range: boolean

diskSize
type: Property
domain: GoldenImage
range: string

osArch
type: Property
domain: GoldenImage
range: string

osName
type: Property
domain: GoldenImage
range: string

osVersion
type: Property
domain: GoldenImage
range: string

defaultShell
type: Property
domain: GoldenImage
range: string

preinstalledPackages
type: Property
domain: GoldenImage

description
type: Property
domain: GoldenImage
range: string

HelmComponent
type: Class
title: HelmComponent
supported operation: Retrieves HelmComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves HelmComponent resource.
  deprecated: true
  returns: Nothing

IngressControllerAddon
type: Class
title: IngressControllerAddon
supported property: SupportedProperty
  property: addonConfiguration
  title: addonConfiguration
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRemovable
  title: isRemovable
  required: false
  readable: false
  writeable: false
supported operation: Retrieves IngressControllerAddon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves IngressControllerAddon resource.
  returns: IngressControllerAddon
supported operation: Replaces the IngressControllerAddon resource.
  type: Operation
  type: ReplaceAction
  expects: IngressControllerAddon
  method: PUT
  title: Replaces the IngressControllerAddon resource.
  returns: IngressControllerAddon
supported operation: Deletes the IngressControllerAddon resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the IngressControllerAddon resource.
  returns: Nothing

addonConfiguration
type: Property
domain: IngressControllerAddon

enabled
type: Property
domain: IngressControllerAddon
range: boolean

type
type: Property
domain: IngressControllerAddon
range: string

status
type: Property
domain: IngressControllerAddon
range: string

kubernetesIntegration
type: Link
domain: IngressControllerAddon
max cardinality: 1
range: KubernetesIntegration

isRemovable
type: Property
domain: IngressControllerAddon

InitContainerComponent
type: Class
title: InitContainerComponent
supported operation: Retrieves InitContainerComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves InitContainerComponent resource.
  deprecated: true
  returns: Nothing

KubernetesDashboardAddon
type: Class
title: KubernetesDashboardAddon
supported property: SupportedProperty
  property: addonConfiguration
  title: addonConfiguration
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRemovable
  title: isRemovable
  required: false
  readable: false
  writeable: false
supported operation: Retrieves KubernetesDashboardAddon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves KubernetesDashboardAddon resource.
  returns: KubernetesDashboardAddon
supported operation: Replaces the KubernetesDashboardAddon resource.
  type: Operation
  type: ReplaceAction
  expects: KubernetesDashboardAddon
  method: PUT
  title: Replaces the KubernetesDashboardAddon resource.
  returns: KubernetesDashboardAddon
supported operation: Deletes the KubernetesDashboardAddon resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the KubernetesDashboardAddon resource.
  returns: Nothing

addonConfiguration
type: Property
domain: KubernetesDashboardAddon

enabled
type: Property
domain: KubernetesDashboardAddon
range: boolean

type
type: Property
domain: KubernetesDashboardAddon
range: string

status
type: Property
domain: KubernetesDashboardAddon
range: string

kubernetesIntegration
type: Link
domain: KubernetesDashboardAddon
max cardinality: 1
range: KubernetesIntegration

isRemovable
type: Property
domain: KubernetesDashboardAddon

KubernetesIntegration
type: Class
title: KubernetesIntegration
supported property: SupportedProperty
  property: managed
  title: managed
  required: false
  readable: true
  writeable: false
  description: This means this is a cluster running on our infrastructure.
supported property: SupportedProperty
  property: managedRegion
  title: managedRegion
  required: false
  readable: true
  writeable: false
  description: For the managed ones, and especially for the shared ones too, to what Hosting Regions it belongs
supported property: SupportedProperty
  property: demo
  title: demo
  required: false
  readable: true
  writeable: false
  description: Most probably is managed too and shared, And it means it has demo purpose, so apart from the managed limitations (see above) and shared limitations (see above), the user should not be able to: - deploy Kube and Helm components - any env deployed on this cluster will have an auto-stop after 2 hours
supported property: SupportedProperty
  property: autoUpdates
  title: autoUpdates
  required: false
  readable: true
  writeable: true
  description: If false, any add-on updates to be applied will wait for user to click "Apply Configuration"
supported property: SupportedProperty
  property: clusterName
  title: clusterName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterServer
  title: clusterUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: caCertificate
  title: caCertificate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userCertificate
  title: userCertificate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userCertificatePrivateKey
  title: userCertificatePrivateKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloud
  title: cloud
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloudRegion
  title: cloudRegion
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cloudClusterName
  title: cloudClusterName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: projectId
  title: projectId
  required: false
  readable: true
  writeable: true
  description: For GCP -> Project Id For Azure -> Tenant Id
supported property: SupportedProperty
  property: userToken
  title: userToken
  required: false
  readable: true
  writeable: true
  description: The token used to connect to the Kubernetes cluster It may be available for long-term use, in case it is not changed - or - It may be available for short-term use, in which case it will be renewed (if needed) after loading it from the DB $userTokenId and $userTokenSecret will be used for renewal
supported property: SupportedProperty
  property: userTokenId
  title: userTokenId
  required: false
  readable: true
  writeable: true
  description: The "user" part of the login needed to update the token For AWS -> Access Key ID For GCP -> Service Account ID For Azure -> Access Key ID
supported property: SupportedProperty
  property: userTokenSecret
  title: userTokenSecret
  required: false
  readable: false
  writeable: true
  description: The "password" part of the login needed to update the token For AWS -> Secret Access Key For GCP -> Service Account Key For Azure -> Access Secret Key
supported property: SupportedProperty
  property: awsSessionToken
  title: awsSessionToken
  required: false
  readable: true
  writeable: true
  description: For AWS -> Session Token, optional; for temporary access (users asked for this when testing, they want a temporary connection with Bunnyshell)
supported property: SupportedProperty
  property: awsIamRoleArn
  title: awsIamRoleArn
  required: false
  readable: true
  writeable: true
  description: For AWS -> IAM Role Arn for assume role auth mechanism (You have a simple user, with no permission other than assume role from a specific IP, and based on that role he can have access to EKS cluster)
supported property: SupportedProperty
  property: userTokenExpiration
  title: userTokenExpiration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubeconfig
  title: kubeconfig
  required: false
  readable: false
  writeable: true
  description: Can be used for DIGITAL_OCEAN and DT_CLOUD and SCALEWAY, it expects a kubeconfig file content, and it will try to extract the fields needed, just a alternate and simpler way to send those params
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addons
  title: addons
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubeServerVersion
  title: kubeServerVersion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: checkingStatus
  title: checkingStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: configurationVersion
  title: configurationVersion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: configurationApplyScheduledAt
  title: configurationApplyScheduledAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasDefaultStorageClass
  title: hasDefaultStorageClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: diskPvCapability
  title: diskPvCapability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: networkPvCapability
  title: networkPvCapability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ingressCapability
  title: ingressCapability
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: maxParallelWorkflows
  title: maxParallelWorkflows
  required: false
  readable: true
  writeable: true
  description: todo nice: todo workflowSettings: to be separated in a workflowSettings table (But not the one existing and added to Env, Proj and Org), as it it much more limited OR if we really want to keep all settings in that table, to add extra column, kubeMaxParallelWorkflows, and to be used only for kubes, like we have projectMaxParallelWorkflows, organizationMaxParallelWorkflows
supported operation: Retrieves KubernetesIntegration resource.
supported operation: Replaces the KubernetesIntegration resource.
supported operation: Creates a KubernetesIntegration resource.
supported operation: Retrieves the collection of Addon resources.

managed
type: Property
domain: KubernetesIntegration
range: boolean

managedRegion
type: Property
domain: KubernetesIntegration
range: string

demo
type: Property
domain: KubernetesIntegration
range: boolean

autoUpdates
type: Property
domain: KubernetesIntegration
range: boolean

clusterName
type: Property
domain: KubernetesIntegration
range: string

caCertificate
type: Property
domain: KubernetesIntegration
range: string

userCertificate
type: Property
domain: KubernetesIntegration
range: string

userCertificatePrivateKey
type: Property
domain: KubernetesIntegration
range: string

cloud
type: Property
domain: KubernetesIntegration
max cardinality: 1
range: CloudProvider

cloudRegion
type: Property
domain: KubernetesIntegration
range: string

cloudClusterName
type: Property
domain: KubernetesIntegration
range: string

projectId
type: Property
domain: KubernetesIntegration
range: string

userToken
type: Property
domain: KubernetesIntegration
range: string

userTokenId
type: Property
domain: KubernetesIntegration
range: string

userTokenSecret
type: Property
domain: KubernetesIntegration
range: string

awsSessionToken
type: Property
domain: KubernetesIntegration
range: string

awsIamRoleArn
type: Property
domain: KubernetesIntegration
range: string

userTokenExpiration
type: Property
domain: KubernetesIntegration
range: dateTime

kubeconfig
type: Property
domain: KubernetesIntegration
range: string

organization
type: Link
domain: KubernetesIntegration
max cardinality: 1
range: Organization

addons
type: Property
domain: KubernetesIntegration
range: Addon

status
type: Property
domain: KubernetesIntegration
range: string

kubeServerVersion
type: Property
domain: KubernetesIntegration
range: string

checkingStatus
type: Property
domain: KubernetesIntegration
range: string

configurationVersion
type: Property
domain: KubernetesIntegration
range: string

configurationApplyScheduledAt
type: Property
domain: KubernetesIntegration
range: dateTime

hasDefaultStorageClass
type: Property
domain: KubernetesIntegration
range: boolean

diskPvCapability
type: Property
domain: KubernetesIntegration
range: string

networkPvCapability
type: Property
domain: KubernetesIntegration
range: string

ingressCapability
type: Property
domain: KubernetesIntegration
range: string

maxParallelWorkflows
type: Property
domain: KubernetesIntegration
range: integer

latestWorkflow
type: Property
domain: KubernetesIntegration
max cardinality: 1
range: Workflow

hasOutdatedConfiguration
type: Property
domain: KubernetesIntegration

clusterHasMultipleIntegrations
type: Property
domain: KubernetesIntegration

addonCostTrackingIsDataCollectionSuspended
type: Property
domain: KubernetesIntegration

addonCostTrackingDataCollectionErrorAt
type: Property
domain: KubernetesIntegration

KubernetesManifestComponent
type: Class
title: KubernetesManifestComponent
supported operation: Retrieves KubernetesManifestComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves KubernetesManifestComponent resource.
  deprecated: true
  returns: Nothing

LogEntry
type: Class
title: LogEntry
supported property: SupportedProperty
  property: eventId
  title: eventId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environmentId
  title: environmentId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: serviceComponentId
  title: serviceComponentId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deploymentJobId
  title: deploymentJobId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buildJobId
  title: buildJobId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activity
  title: activity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: level
  title: level
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: time
  title: time
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalLogFile
  title: externalLogFile
  required: false
  readable: true
  writeable: true
supported operation: Retrieves LogEntry resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves LogEntry resource.
  returns: LogEntry
supported operation: Retrieves LogEntry resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves LogEntry resource.
  returns: LogEntry
description: !!! A separate collection will be used for each organization

eventId
type: Property
domain: LogEntry
range: integer

environmentId
type: Property
domain: LogEntry
range: integer

serviceComponentId
type: Property
domain: LogEntry
range: integer

deploymentJobId
type: Property
domain: LogEntry
range: integer

buildJobId
type: Property
domain: LogEntry
range: integer

activity
type: Property
domain: LogEntry
range: string

level
type: Property
domain: LogEntry
range: string

message
type: Property
domain: LogEntry
range: string

time
type: Property
domain: LogEntry
range: dateTime

externalLogFile
type: Property
domain: LogEntry
range: string

Organization
type: Class
title: Organization
supported property: SupportedProperty
  property: unique
  title: unique
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timezone
  title: timezone
  required: false
  readable: true
  writeable: true
  description: One of the PHP timezone identifiers (https://www.php.net/manual/en/timezones.php)
supported property: SupportedProperty
  property: companySize
  title: companySize
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountOwner
  title: accountOwner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: projects
  title: projects
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: registryIntegration
  title: registryIntegration
  required: false
  readable: true
  writeable: false
  description: BuildSettings Organization Default RegistryIntegration (also marked as default in the registryIntegrations listing)
supported property: SupportedProperty
  property: buildEngine
  title: buildEngine
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billingMode
  title: billingMode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceType
  title: invoiceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isGated
  title: isGated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hasOnboardingSurvey
  title: hasOnboardingSurvey
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: usesGithubApp
  title: usesGithubApp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegrationsCount
  title: kubernetesIntegrationsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: gitIntegrationsCount
  title: gitIntegrationsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: slackIntegrationsCount
  title: slackIntegrationsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamsIntegrationsCount
  title: teamsIntegrationsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationUsersCount
  title: organizationUsersCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: customTemplatesRepositoriesCount
  title: customTemplatesRepositoriesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publicId
  title: publicId
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: organizationUsers
  title: organizationUsers
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: slackIntegrations
  title: slackIntegrations
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: teamsIntegrations
  title: teamsIntegrations
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: gitIntegrations
  title: gitIntegrations
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: templates
  title: templates
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: templatesRepositories
  title: templatesRepositories
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegrations
  title: kubernetesIntegrations
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: registryIntegrations
  title: registryIntegrations
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: events
  title: events
  required: false
  readable: false
  writeable: false
supported operation: Retrieves Organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Organization resource.
  returns: Organization
supported operation: Replaces the Organization resource.
supported operation: Creates a Organization resource.
supported operation: Deletes the Organization resource.
supported operation: Retrieves the collection of Project resources.
supported operation: Retrieves the collection of Environment resources.
supported operation: Retrieves the collection of EnvironmentVariable resources.
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
supported operation: Retrieves the collection of ProjectTimeframe resources.
supported operation: Retrieves the collection of ProjectVariable resources.
supported operation: Retrieves the collection of GitIntegration resources.
supported operation: Retrieves the collection of KubernetesIntegration resources.
supported operation: Retrieves the collection of Event resources.
supported operation: Retrieves the collection of OrganizationUser resources.
supported operation: Retrieves the collection of RegistryIntegration resources.
supported operation: Retrieves the collection of TemplatesRepository resources.
supported operation: Retrieves the collection of Template resources.
supported operation: Retrieves the collection of SlackIntegration resources.
supported operation: Retrieves the collection of TeamsIntegration resources.

unique
type: Property
domain: Organization
range: string

name
type: Property
domain: Organization
range: string

timezone
type: Property
domain: Organization
range: string

companySize
type: Property
domain: Organization
range: string

accountOwner
type: Property
domain: Organization
max cardinality: 1
range: User

projects
type: Link
domain: Organization
range: Project

registryIntegration
type: Property
domain: Organization
max cardinality: 1
range: RegistryIntegration

buildEngine
type: Property
domain: Organization
range: string

billingMode
type: Property
domain: Organization
range: string

invoiceType
type: Property
domain: Organization
range: string

isGated
type: Property
domain: Organization
range: boolean

hasOnboardingSurvey
type: Property
domain: Organization
range: boolean

usesGithubApp
type: Property
domain: Organization
range: boolean

createdAt
type: Property
domain: Organization
range: dateTime

updatedAt
type: Property
domain: Organization
range: dateTime

deletedAt
type: Property
domain: Organization
range: dateTime

kubernetesIntegrationsCount
type: Property
domain: Organization
range: integer

gitIntegrationsCount
type: Property
domain: Organization
range: integer

slackIntegrationsCount
type: Property
domain: Organization
range: integer

teamsIntegrationsCount
type: Property
domain: Organization
range: integer

organizationUsersCount
type: Property
domain: Organization
range: integer

customTemplatesRepositoriesCount
type: Property
domain: Organization
range: integer

publicId
type: Property
domain: Organization

organizationUsers
type: Property
domain: Organization
range: OrganizationUser

slackIntegrations
type: Property
domain: Organization
range: SlackIntegration

teamsIntegrations
type: Property
domain: Organization
range: TeamsIntegration

gitIntegrations
type: Property
domain: Organization
range: GitIntegration

templates
type: Property
domain: Organization
range: Template

templatesRepositories
type: Property
domain: Organization
range: TemplatesRepository

kubernetesIntegrations
type: Property
domain: Organization
range: KubernetesIntegration

registryIntegrations
type: Property
domain: Organization
range: RegistryIntegration

events
type: Property
domain: Organization
range: Event

OrganizationUser
type: Class
title: OrganizationUser
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invitationSentAt
  title: invitationSentAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invitationAcceptedAt
  title: invitationAcceptedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves OrganizationUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OrganizationUser resource.
  returns: OrganizationUser
supported operation: Creates a OrganizationUser resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a OrganizationUser resource.
  returns: OrganizationUser
supported operation: Creates a OrganizationUser resource.
  type: Operation
  type: CreateAction
  expects: OrganizationUser
  method: POST
  title: Creates a OrganizationUser resource.
  returns: OrganizationUser
supported operation: Retrieves OrganizationUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OrganizationUser resource.
  returns: OrganizationUser
supported operation: Replaces the OrganizationUser resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the OrganizationUser resource.
  returns: OrganizationUser
supported operation: Replaces the OrganizationUser resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the OrganizationUser resource.
  returns: OrganizationUser
supported operation: Deletes the OrganizationUser resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the OrganizationUser resource.
  returns: Nothing

organization
type: Link
domain: OrganizationUser
max cardinality: 1
range: Organization

user
type: Property
domain: OrganizationUser
max cardinality: 1
range: User

status
type: Property
domain: OrganizationUser
range: string

email
type: Property
domain: OrganizationUser
range: string

invitationSentAt
type: Property
domain: OrganizationUser
range: dateTime

invitationAcceptedAt
type: Property
domain: OrganizationUser
range: dateTime

Project
type: Class
title: Project
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: autoUpdate
  title: autoUpdate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environments
  title: environments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectVariables
  title: projectVariables
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectReleaseSettings
  title: projectReleaseSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: environmentExpiryIntervalSeconds
  title: environmentExpiryIntervalSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environmentUndeployIntervalSeconds
  title: environmentUndeployIntervalSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: buildSettings
  title: buildSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deploymentRunnerSettings
  title: deploymentRunnerSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workflowSettings
  title: workflowSettings
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: labels
  title: labels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: environmentsCount
  title: environmentsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accessibleEnvironmentsCount
  title: accessibleEnvironmentsCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workspacesCount
  title: workspacesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accessibleWorkspacesCount
  title: accessibleWorkspacesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publicId
  title: publicId
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: timeframes
  title: timeframes
  required: false
  readable: false
  writeable: false
supported operation: Retrieves Project resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Project resource.
  returns: Project
supported operation: Replaces the Project resource.
  type: Operation
  type: ReplaceAction
  expects: Project
  method: PUT
  title: Replaces the Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Replaces the Project resource.
  type: Operation
  type: ReplaceAction
  expects: Project
  method: PUT
  title: Replaces the Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Retrieves Project resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Project resource.
  returns: Project
supported operation: Retrieves Project resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Project resource.
  returns: Project
supported operation: Deletes the Project resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Project resource.
  returns: Nothing
supported operation: Retrieves the collection of Environment resources.
supported operation: Retrieves the collection of EnvironmentVariable resources.
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
supported operation: Retrieves the collection of ProjectTimeframe resources.
supported operation: Retrieves the collection of ProjectVariable resources.

name
type: Property
domain: Project
range: string

autoUpdate
type: Property
domain: Project
range: boolean

organization
type: Link
domain: Project
max cardinality: 1
range: Organization

environments
type: Link
domain: Project
range: Environment

projectVariables
type: Link
domain: Project
range: ProjectVariable

projectReleaseSettings
type: Property
domain: Project

environmentExpiryIntervalSeconds
type: Property
domain: Project
range: integer

environmentUndeployIntervalSeconds
type: Property
domain: Project
range: integer

createdAt
type: Property
domain: Project
range: dateTime

updatedAt
type: Property
domain: Project
range: dateTime

deletedAt
type: Property
domain: Project
range: dateTime

buildSettings
type: Property
domain: Project

deploymentRunnerSettings
type: Property
domain: Project

workflowSettings
type: Property
domain: Project

labels
type: Property
domain: Project
range: string

environmentsCount
type: Property
domain: Project

accessibleEnvironmentsCount
type: Property
domain: Project

workspacesCount
type: Property
domain: Project

accessibleWorkspacesCount
type: Property
domain: Project

publicId
type: Property
domain: Project

timeframes
type: Property
domain: Project
range: ProjectTimeframe

ProjectTimeframe
type: Class
title: ProjectTimeframe
supported property: SupportedProperty
  property: project
  title: project
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeframe
  title: timeframe
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startHour
  title: startHour
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endHour
  title: endHour
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ProjectTimeframe resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ProjectTimeframe resource.
  returns: ProjectTimeframe
supported operation: Deletes the ProjectTimeframe resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectTimeframe resource.
  returns: Nothing

project
type: Link
domain: ProjectTimeframe
max cardinality: 1
range: Project

timeframe
type: Property
domain: ProjectTimeframe
max cardinality: 1
range: Timeframe

startHour
type: Property
domain: ProjectTimeframe
range: dateTime

endHour
type: Property
domain: ProjectTimeframe
range: dateTime

ProjectVariable
type: Class
title: ProjectVariable
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSecret
  title: isSecret
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ProjectVariable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ProjectVariable resource.
  returns: ProjectVariable
supported operation: Replaces the ProjectVariable resource.
  type: Operation
  type: ReplaceAction
  expects: ProjectVariable
  method: PUT
  title: Replaces the ProjectVariable resource.
  returns: ProjectVariable
supported operation: Deletes the ProjectVariable resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectVariable resource.
  returns: Nothing

project
type: Link
domain: ProjectVariable
max cardinality: 1
range: Project

name
type: Property
domain: ProjectVariable
range: string

value
type: Property
domain: ProjectVariable
range: string

isSecret
type: Property
domain: ProjectVariable
range: boolean

RegistryIntegration
type: Class
title: RegistryIntegration
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: region
  title: region
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: username
  title: username
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accessKey
  title: accessKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accessSecret
  title: accessSecret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: repositoryName
  title: repositoryName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gcpTokenKey
  title: gcpTokenKey
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: gcpProjectId
  title: gcpProjectId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported operation: Retrieves RegistryIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves RegistryIntegration resource.
  returns: RegistryIntegration
supported operation: Replaces the RegistryIntegration resource.
  type: Operation
  type: ReplaceAction
  expects: RegistryIntegration
  method: PUT
  title: Replaces the RegistryIntegration resource.
  returns: RegistryIntegration
supported operation: Replaces the RegistryIntegration resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the RegistryIntegration resource.
  returns: RegistryIntegration
supported operation: Replaces the RegistryIntegration resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the RegistryIntegration resource.
  returns: RegistryIntegration

organization
type: Link
domain: RegistryIntegration
max cardinality: 1
range: Organization

name
type: Property
domain: RegistryIntegration
range: string

region
type: Property
domain: RegistryIntegration
range: string

username
type: Property
domain: RegistryIntegration
range: string

accessKey
type: Property
domain: RegistryIntegration
range: string

accessSecret
type: Property
domain: RegistryIntegration
range: string

status
type: Property
domain: RegistryIntegration
range: string

provider
type: Property
domain: RegistryIntegration
max cardinality: 1
range: RegistryProvider

repositoryName
type: Property
domain: RegistryIntegration
range: string

gcpTokenKey
type: Property
domain: RegistryIntegration
range: string

gcpProjectId
type: Property
domain: RegistryIntegration
range: string

url
type: Property
domain: RegistryIntegration
range: string

RegistryProvider
type: Class
title: RegistryProvider
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported operation: Retrieves RegistryProvider resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves RegistryProvider resource.
  returns: RegistryProvider

type
type: Property
domain: RegistryProvider
range: string

slug
type: Property
domain: RegistryProvider
range: string

Service
type: Class
title: Service
supported operation: Retrieves Service resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Service resource.
  deprecated: true
  returns: Nothing

ServiceComponentVariable
type: Class
title: ServiceComponentVariable
supported operation: Retrieves ServiceComponentVariable resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ServiceComponentVariable resource.
  deprecated: true
  returns: Nothing

SidecarContainerComponent
type: Class
title: SidecarContainerComponent
supported operation: Retrieves SidecarContainerComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SidecarContainerComponent resource.
  deprecated: true
  returns: Nothing

SlackIntegration
type: Class
title: SlackIntegration
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accessToken
  title: accessToken
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: exchangeCode
  title: exchangeCode
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: stateCode
  title: stateCode
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: true
  readable: true
  writeable: true
supported operation: Retrieves SlackIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SlackIntegration resource.
  returns: SlackIntegration
supported operation: Retrieves SlackIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SlackIntegration resource.
  returns: SlackIntegration
supported operation: Deletes the SlackIntegration resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the SlackIntegration resource.
  returns: Nothing

organizationId
type: Property
domain: SlackIntegration
range: integer

organization
type: Link
domain: SlackIntegration
max cardinality: 1
range: Organization

accessToken
type: Property
domain: SlackIntegration
range: string

channels
type: Property
domain: SlackIntegration

team
type: Property
domain: SlackIntegration
range: string

teamId
type: Property
domain: SlackIntegration
range: string

status
type: Property
domain: SlackIntegration
range: string

exchangeCode
type: Property
domain: SlackIntegration
range: string

stateCode
type: Property
domain: SlackIntegration
range: string

StaticApplication
type: Class
title: StaticApplication
supported operation: Retrieves StaticApplication resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves StaticApplication resource.
  deprecated: true
  returns: Nothing

TeamsIntegration
type: Class
title: TeamsIntegration
supported property: SupportedProperty
  property: organization
  title: organization
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterServer
  title: webhookUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported operation: Retrieves TeamsIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TeamsIntegration resource.
  returns: TeamsIntegration
supported operation: Replaces the TeamsIntegration resource.
  type: Operation
  type: ReplaceAction
  expects: TeamsIntegration
  method: PUT
  title: Replaces the TeamsIntegration resource.
  returns: TeamsIntegration
supported operation: Deletes the TeamsIntegration resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TeamsIntegration resource.
  returns: Nothing

organization
type: Link
domain: TeamsIntegration
max cardinality: 1
range: Organization

type
type: Property
domain: TeamsIntegration
range: string

name
type: Property
domain: TeamsIntegration
range: string

status
type: Property
domain: TeamsIntegration
range: string

Template
type: Class
title: Template
supported property: SupportedProperty
  property: key
  title: key
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: templatesRepository
  title: templatesRepository
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gitSha
  title: gitSha
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shortDescription
  title: shortDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: icons
  title: icons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: categories
  title: categories
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSyncStatus
  title: lastSyncStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSyncDate
  title: lastSyncDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: variables
  title: variables
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Template resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Template resource.
  returns: Template
supported operation: Retrieves Template resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Template resource.
  returns: Template

key
type: Property
domain: Template
range: string

templatesRepository
type: Link
domain: Template
max cardinality: 1
range: TemplatesRepository

organization
type: Link
domain: Template
max cardinality: 1
range: Organization

gitSha
type: Property
domain: Template
range: string

name
type: Property
domain: Template
range: string

shortDescription
type: Property
domain: Template
range: string

tags
type: Property
domain: Template
range: string

icons
type: Property
domain: Template
range: string

categories
type: Property
domain: Template
range: string

lastSyncStatus
type: Property
domain: Template
range: string

lastSyncDate
type: Property
domain: Template
range: dateTime

variables
type: Property
domain: Template

createdAt
type: Property
domain: Template
range: dateTime

updatedAt
type: Property
domain: Template
range: dateTime

TemplatesRepository
type: Class
title: TemplatesRepository
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: clusterServer
  title: gitRepositoryUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gitRef
  title: gitRef
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: autoSyncOnGitPush
  title: autoSyncOnGitPush
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSyncDate
  title: lastSyncDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSyncSha
  title: lastSyncSha
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastSyncResults
  title: lastSyncResults
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gitProviderType
  title: gitProviderType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: gitRepositoryName
  title: gitRepositoryName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: gitRepositoryOwnerName
  title: gitRepositoryOwnerName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: templates
  title: templates
  required: false
  readable: false
  writeable: true
supported operation: Retrieves TemplatesRepository resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TemplatesRepository resource.
  returns: TemplatesRepository
supported operation: Replaces the TemplatesRepository resource.
  type: Operation
  type: ReplaceAction
  expects: TemplatesRepository
  method: PUT
  title: Replaces the TemplatesRepository resource.
  returns: TemplatesRepository
supported operation: Deletes the TemplatesRepository resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TemplatesRepository resource.
  returns: Nothing
supported operation: Creates a TemplatesRepository resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a TemplatesRepository resource.
  returns: TemplatesRepository
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Template

name
type: Property
domain: TemplatesRepository
range: string

gitRef
type: Property
domain: TemplatesRepository
range: string

status
type: Property
domain: TemplatesRepository
range: string

autoSyncOnGitPush
type: Property
domain: TemplatesRepository
range: boolean

lastSyncDate
type: Property
domain: TemplatesRepository
range: dateTime

lastSyncSha
type: Property
domain: TemplatesRepository
range: string

lastSyncResults
type: Property
domain: TemplatesRepository

organization
type: Link
domain: TemplatesRepository
max cardinality: 1
range: Organization

gitProviderType
type: Property
domain: TemplatesRepository
range: string

gitRepositoryName
type: Property
domain: TemplatesRepository
range: string

gitRepositoryOwnerName
type: Property
domain: TemplatesRepository
range: string

templates
type: Link
domain: TemplatesRepository
range: Template

TerraformComponent
type: Class
title: TerraformComponent
supported operation: Retrieves TerraformComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TerraformComponent resource.
  deprecated: true
  returns: Nothing

Timeframe
type: Class
title: Timeframe
supported property: SupportedProperty
  property: timeframe
  title: timeframe
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Timeframe resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Timeframe resource.
  returns: Timeframe

timeframe
type: Property
domain: Timeframe
range: string

User
type: Class
title: User
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: initialBillingPlan
  title: initialBillingPlan
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: registrationStep
  title: registrationStep
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: intercomExternalId
  title: intercomExternalId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: intercomUserHash
  title: intercomUserHash
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userPreferences
  title: userPreferences
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isAdmin
  title: isAdmin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizations
  title: organizations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationUserIds
  title: organizationUserIds
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ownedOrganizations
  title: ownedOrganizations
  required: false
  readable: false
  writeable: false
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Deletes the User resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the User resource.
  returns: Nothing
supported operation: Retrieves a UserPreferences resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a UserPreferences resource.
  returns: UserPreferences
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  returns: Organization

password
type: Property
domain: User
range: string

firstName
type: Property
domain: User
range: string

lastName
type: Property
domain: User
range: string

phoneNumber
type: Property
domain: User
range: string

initialBillingPlan
type: Property
domain: User
range: string

registrationStep
type: Property
domain: User
range: string

intercomExternalId
type: Property
domain: User
range: string

intercomUserHash
type: Property
domain: User
range: string

userPreferences
type: Link
domain: User
max cardinality: 1
range: UserPreferences

createdAt
type: Property
domain: User
range: dateTime

updatedAt
type: Property
domain: User
range: dateTime

isAdmin
type: Property
domain: User
range: boolean

organizations
type: Link
domain: User
range: Organization

organizationUserIds
type: Property
domain: User

ownedOrganizations
type: Property
domain: User
range: Organization

UserPreferences
type: Class
title: UserPreferences
supported operation: Retrieves UserPreferences resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserPreferences resource.
  deprecated: true
  returns: Nothing
supported operation: Retrieves UserPreferences resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserPreferences resource.
  returns: UserPreferences
supported operation: Replaces the UserPreferences resource.
  type: Operation
  type: ReplaceAction
  expects: UserPreferences
  method: PUT
  title: Replaces the UserPreferences resource.
  returns: UserPreferences

Workflow
type: Class
title: Workflow
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: event
  title: event
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusChangedAt
  title: statusChangedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: triggerEvent
  title: triggerEvent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: relatedJobType
  title: relatedJobType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedJobIdentifier
  title: relatedJobIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: jobs
  title: jobs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startedAt
  title: startedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endedAt
  title: endedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hashID
  title: hashID
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isAborted
  title: isAborted
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: timeoutSeconds
  title: timeoutSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedJob
  title: relatedJob
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationUnique
  title: organizationUnique
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: throttled
  title: throttled
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: throttle
  title: throttle
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: throttleJob
  title: throttleJob
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: aborting
  title: aborting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: failing
  title: failing
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: terminable
  title: terminable
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: successful
  title: successful
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: terminated
  title: terminated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedTopicalResources
  title: relatedTopicalResources
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: environment
  title: environment
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: kubernetesIntegration
  title: kubernetesIntegration
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: supportingAbort
  title: supportingAbort
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: canBeTerminated
  title: canBeTerminated
  required: false
  readable: true
  writeable: false
  description: We set this on specific serialization groups.
supported operation: Retrieves Workflow resource.
supported operation: Creates a Workflow resource.

name
type: Property
domain: Workflow
range: string

event
type: Link
domain: Workflow
max cardinality: 1
range: Event

status
type: Property
domain: Workflow
range: string

statusChangedAt
type: Property
domain: Workflow
range: dateTime

triggerEvent
type: Property
domain: Workflow

relatedJobType
type: Property
domain: Workflow
range: string

relatedJobIdentifier
type: Property
domain: Workflow
range: string

description
type: Property
domain: Workflow
range: string

jobs
type: Link
domain: Workflow
range: WorkflowJob

createdAt
type: Property
domain: Workflow
range: dateTime

updatedAt
type: Property
domain: Workflow
range: dateTime

startedAt
type: Property
domain: Workflow
range: dateTime

endedAt
type: Property
domain: Workflow
range: dateTime

hashID
type: Property
domain: Workflow
range: string

isAborted
type: Property
domain: Workflow
range: boolean

timeoutSeconds
type: Property
domain: Workflow
range: integer

user
type: Link
domain: Workflow
max cardinality: 1
range: User

relatedJob
type: Property
domain: Workflow

organization
type: Link
domain: Workflow
max cardinality: 1
range: Organization

organizationUnique
type: Property
domain: Workflow
range: string

throttled
type: Property
domain: Workflow
range: boolean

throttle
type: Property
domain: Workflow
range: boolean

throttleJob
type: Link
domain: Workflow
max cardinality: 1
range: WorkflowJob

aborting
type: Property
domain: Workflow
range: boolean

failing
type: Property
domain: Workflow
range: boolean

terminable
type: Property
domain: Workflow
range: boolean

successful
type: Property
domain: Workflow
range: boolean

terminated
type: Property
domain: Workflow
range: boolean

relatedTopicalResources
type: Property
domain: Workflow

environment
type: Link
domain: Workflow
max cardinality: 1
range: Environment

kubernetesIntegration
type: Link
domain: Workflow
max cardinality: 1
range: KubernetesIntegration

supportingAbort
type: Property
domain: Workflow
range: boolean

canBeTerminated
type: Property
domain: Workflow
range: boolean

duration
type: Property
domain: Workflow
range: integer

hashIDOrThrow
type: Property
domain: Workflow
range: string

aborted
type: Property
domain: Workflow
range: boolean

WorkflowJob
type: Class
title: WorkflowJob
supported property: SupportedProperty
  property: workflow
  title: workflow
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: relatedResourceType
  title: relatedResourceType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedResourceIdentifier
  title: relatedResourceIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedJobType
  title: relatedJobType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: relatedJobIdentifier
  title: relatedJobIdentifier
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowedToFail
  title: allowedToFail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusChangedAt
  title: statusChangedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dependantJobs
  title: dependantJobs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dependencyJobs
  title: dependencyJobs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startedAt
  title: startedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endedAt
  title: endedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeoutSeconds
  title: timeoutSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: relatedResource
  title: relatedResource
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: pending
  title: pending
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: aborting
  title: aborting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: failed
  title: failed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: success
  title: success
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: terminalStatus
  title: terminalStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: dispatched
  title: dispatched
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: completed
  title: completed
  required: false
  readable: true
  writeable: false
  description: This indicates if a dependant job of this one can be triggered.
supported property: SupportedProperty
  property: steps
  title: steps
  required: false
  readable: true
  writeable: false
  description: WorkflowSteps are saved in MongoDB, we cannot declare here relations between ORM and ODM
supported property: SupportedProperty
  property: dependsOnWorkflowJobIds
  title: dependsOnWorkflowJobIds
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationUnique
  title: organizationUnique
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: typeThrottle
  title: typeThrottle
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relatedTopicalResources
  title: relatedTopicalResources
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
supported operation: Retrieves WorkflowJob resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WorkflowJob resource.
  returns: WorkflowJob

workflow
type: Link
domain: WorkflowJob
max cardinality: 1
range: Workflow

name
type: Property
domain: WorkflowJob
range: string

type
type: Property
domain: WorkflowJob
range: string

relatedResourceType
type: Property
domain: WorkflowJob
range: string

relatedResourceIdentifier
type: Property
domain: WorkflowJob
range: string

relatedJobType
type: Property
domain: WorkflowJob
range: string

relatedJobIdentifier
type: Property
domain: WorkflowJob
range: string

allowedToFail
type: Property
domain: WorkflowJob
range: boolean

status
type: Property
domain: WorkflowJob
range: string

statusChangedAt
type: Property
domain: WorkflowJob
range: dateTime

dependantJobs
type: Link
domain: WorkflowJob
range: WorkflowJob

dependencyJobs
type: Link
domain: WorkflowJob
range: WorkflowJob

createdAt
type: Property
domain: WorkflowJob
range: dateTime

updatedAt
type: Property
domain: WorkflowJob
range: dateTime

startedAt
type: Property
domain: WorkflowJob
range: dateTime

endedAt
type: Property
domain: WorkflowJob
range: dateTime

timeoutSeconds
type: Property
domain: WorkflowJob
range: integer

relatedResource
type: Property
domain: WorkflowJob

pending
type: Property
domain: WorkflowJob
range: boolean

aborting
type: Property
domain: WorkflowJob
range: boolean

failed
type: Property
domain: WorkflowJob
range: boolean

success
type: Property
domain: WorkflowJob
range: boolean

terminalStatus
type: Property
domain: WorkflowJob
range: boolean

dispatched
type: Property
domain: WorkflowJob
range: boolean

completed
type: Property
domain: WorkflowJob
range: boolean

steps
type: Link
domain: WorkflowJob
range: WorkflowStep

dependsOnWorkflowJobIds
type: Property
domain: WorkflowJob
range: integer

organizationUnique
type: Property
domain: WorkflowJob
range: string

organization
type: Link
domain: WorkflowJob
max cardinality: 1
range: Organization

typeThrottle
type: Property
domain: WorkflowJob
range: boolean

relatedTopicalResources
type: Property
domain: WorkflowJob

duration
type: Property
domain: WorkflowJob
range: integer

WorkflowStep
type: Class
title: WorkflowStep
supported operation: Retrieves WorkflowStep resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WorkflowStep resource.
  deprecated: true
  returns: Nothing
description: !!! A separate collection will be used for each organization

WorkspaceVMComponent
type: Class
title: WorkspaceVMComponent
supported operation: Retrieves WorkspaceVMComponent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WorkspaceVMComponent resource.
  deprecated: true
  returns: Nothing

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of admin/hashid resources
  title: The collection of admin/hashid resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of admin/hosting-clusters resources
  title: The collection of admin/hosting-clusters resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of admin/organization resources
  title: The collection of admin/organization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of admin/user resources
  title: The collection of admin/user resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of admin/workspace/golden-images resources
  title: The collection of admin/workspace/golden-images resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of role resources
  title: The collection of role resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of team_member resources
  title: The collection of team_member resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of permission resources
  title: The collection of permission resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of organization_member resources
  title: The collection of organization_member resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of team resources
  title: The collection of team resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of policy resources
  title: The collection of policy resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of resource_matcher resources
  title: The collection of resource_matcher resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_ai_sandbox resources
  title: The collection of external_v1_ai_sandbox resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_environment resources
  title: The collection of external_v1_environment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_environment_variable resources
  title: The collection of external_v1_environment_variable resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_environ_item resources
  title: The collection of external_v1_environ_item resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_event resources
  title: The collection of external_v1_event resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_kubernetes_integration resources
  title: The collection of external_v1_kubernetes_integration resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_organization resources
  title: The collection of external_v1_organization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_pipeline resources
  title: The collection of external_v1_pipeline resources
  readable: true
  writeable: false
  deprecated: true
supported property: SupportedProperty
  property: The collection of external_v1_project resources
  title: The collection of external_v1_project resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_project_variable resources
  title: The collection of external_v1_project_variable resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_registry_integration resources
  title: The collection of external_v1_registry_integration resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_ssh resources
  title: The collection of external_v1_ssh resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_secret resources
  title: The collection of external_v1_secret resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_componentEndpoint resources
  title: The collection of external_v1_componentEndpoint resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_componentGit resources
  title: The collection of external_v1_componentGit resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_component resources
  title: The collection of external_v1_component resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_service_component_variable resources
  title: The collection of external_v1_service_component_variable resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_template resources
  title: The collection of external_v1_template resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_templates_repository resources
  title: The collection of external_v1_templates_repository resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of external_v1_workflow resources
  title: The collection of external_v1_workflow resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BillingProduct resources
  title: The collection of BillingProduct resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BillingProfile resources
  title: The collection of BillingProfile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of BunnyshellVolumesAddon resources
  title: The collection of BunnyshellVolumesAddon resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CloudProvider resources
  title: The collection of CloudProvider resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CostTrackingAddon resources
  title: The collection of CostTrackingAddon resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Environment resources
  title: The collection of Environment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of EnvironmentTimeframe resources
  title: The collection of EnvironmentTimeframe resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of EnvironmentVariable resources
  title: The collection of EnvironmentVariable resources
  readable: true
  writeable: false
supported operation: The API entrypoint.

The collection of admin/hashid resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: admin/hashid
supported operation: Creates a admin/hashid resource.
  type: Operation
  type: CreateAction
  expects: admin/hashid
  method: POST
  title: Creates a admin/hashid resource.
  returns: admin/hashid
supported operation: Creates a admin/hashid resource.
  type: Operation
  type: CreateAction
  expects: admin/hashid
  method: POST
  title: Creates a admin/hashid resource.
  returns: admin/hashid

The collection of admin/hosting-clusters resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: admin/hosting-clusters
supported operation: Retrieves the collection of admin/hosting-clusters resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of admin/hosting-clusters resources.
  returns: Collection
supported operation: Creates a admin/hosting-clusters resource.
  type: Operation
  type: CreateAction
  expects: admin/hosting-clusters
  method: POST
  title: Creates a admin/hosting-clusters resource.
  returns: admin/hosting-clusters

The collection of admin/organization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: admin/organization
supported operation: Retrieves the collection of admin/organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of admin/organization resources.
  returns: Collection
supported operation: Creates a admin/organization resource.
  type: Operation
  type: CreateAction
  expects: admin/organization
  method: POST
  title: Creates a admin/organization resource.
  returns: admin/organization

The collection of admin/user resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: admin/user
supported operation: Retrieves the collection of admin/user resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of admin/user resources.
  returns: Collection
supported operation: Creates a admin/user resource.
  type: Operation
  type: CreateAction
  expects: admin/user
  method: POST
  title: Creates a admin/user resource.
  returns: admin/user

The collection of admin/workspace/golden-images resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: admin/workspace/golden-images
supported operation: Retrieves the collection of admin/workspace/golden-images resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of admin/workspace/golden-images resources.
  returns: Collection
supported operation: Creates a admin/workspace/golden-images resource.
  type: Operation
  type: CreateAction
  expects: admin/workspace/golden-images
  method: POST
  title: Creates a admin/workspace/golden-images resource.
  returns: admin/workspace/golden-images

The collection of role resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: role
supported operation: Retrieves the collection of role resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of role resources.
  returns: Collection

The collection of team_member resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: team_member
supported operation: Retrieves the collection of team_member resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of team_member resources.
  returns: Collection

The collection of permission resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: permission
supported operation: Retrieves the collection of permission resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of permission resources.
  returns: Collection

The collection of organization_member resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: organization_member
supported operation: Retrieves the collection of organization_member resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of organization_member resources.
  returns: Collection

The collection of team resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: team
supported operation: Retrieves the collection of team resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of team resources.
  returns: Collection
supported operation: Creates a team resource.
  type: Operation
  type: CreateAction
  expects: team
  method: POST
  title: Creates a team resource.
  returns: team

The collection of policy resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: policy
supported operation: Retrieves the collection of policy resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of policy resources.
  returns: Collection
supported operation: Creates a policy resource.
  type: Operation
  type: CreateAction
  expects: policy
  method: POST
  title: Creates a policy resource.
  returns: policy

The collection of resource_matcher resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: resource_matcher
supported operation: Retrieves the collection of resource_matcher resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of resource_matcher resources.
  returns: Collection
supported operation: Creates a resource_matcher resource.
  type: Operation
  type: CreateAction
  expects: resource_matcher
  method: POST
  title: Creates a resource_matcher resource.
  returns: resource_matcher

The collection of external_v1_ai_sandbox resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_ai_sandbox
supported operation: Creates a external_v1_ai_sandbox resource.
  type: Operation
  type: CreateAction
  expects: external_v1_ai_sandbox
  method: POST
  title: Creates a external_v1_ai_sandbox resource.
  returns: external_v1_ai_sandbox

The collection of external_v1_environment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_environment
supported operation: Retrieves the collection of external_v1_environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_environment resources.
  returns: Collection
supported operation: Creates a external_v1_environment resource.
  type: Operation
  type: CreateAction
  expects: external_v1_environment
  method: POST
  title: Creates a external_v1_environment resource.
  returns: external_v1_environment

The collection of external_v1_environment_variable resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_environment_variable
supported operation: Retrieves the collection of external_v1_environment_variable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_environment_variable resources.
  returns: Collection
supported operation: Creates a external_v1_environment_variable resource.
  type: Operation
  type: CreateAction
  expects: external_v1_environment_variable
  method: POST
  title: Creates a external_v1_environment_variable resource.
  returns: external_v1_environment_variable

The collection of external_v1_environ_item resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_environ_item
supported operation: Retrieves the collection of external_v1_environ_item resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_environ_item resources.
  returns: Collection
supported operation: Creates a external_v1_environ_item resource.
  type: Operation
  type: CreateAction
  expects: external_v1_environ_item
  method: POST
  title: Creates a external_v1_environ_item resource.
  returns: external_v1_environ_item

The collection of external_v1_event resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_event
supported operation: Retrieves the collection of external_v1_event resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_event resources.
  returns: Collection

The collection of external_v1_kubernetes_integration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_kubernetes_integration
supported operation: Retrieves the collection of external_v1_kubernetes_integration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_kubernetes_integration resources.
  returns: Collection

The collection of external_v1_organization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_organization
supported operation: Retrieves the collection of external_v1_organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_organization resources.
  returns: Collection

The collection of external_v1_pipeline resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_pipeline
supported operation: Retrieves the collection of external_v1_pipeline resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_pipeline resources.
  deprecated: true
  returns: Collection

The collection of external_v1_project resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_project
supported operation: Retrieves the collection of external_v1_project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_project resources.
  returns: Collection
supported operation: Creates a external_v1_project resource.
  type: Operation
  type: CreateAction
  expects: external_v1_project
  method: POST
  title: Creates a external_v1_project resource.
  returns: external_v1_project

The collection of external_v1_project_variable resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_project_variable
supported operation: Retrieves the collection of external_v1_project_variable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_project_variable resources.
  returns: Collection
supported operation: Creates a external_v1_project_variable resource.
  type: Operation
  type: CreateAction
  expects: external_v1_project_variable
  method: POST
  title: Creates a external_v1_project_variable resource.
  returns: external_v1_project_variable

The collection of external_v1_registry_integration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_registry_integration
supported operation: Retrieves the collection of external_v1_registry_integration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_registry_integration resources.
  returns: Collection

The collection of external_v1_ssh resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_ssh
supported operation: Creates a external_v1_ssh resource.
  type: Operation
  type: CreateAction
  expects: external_v1_ssh
  method: POST
  title: Creates a external_v1_ssh resource.
  returns: external_v1_ssh

The collection of external_v1_secret resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_secret
supported operation: Creates a external_v1_secret resource.
  type: Operation
  type: CreateAction
  expects: external_v1_secret
  method: POST
  title: Creates a external_v1_secret resource.
  returns: external_v1_secret
supported operation: Creates a external_v1_secret resource.
  type: Operation
  type: CreateAction
  expects: external_v1_secret
  method: POST
  title: Creates a external_v1_secret resource.
  returns: external_v1_secret
supported operation: Creates a external_v1_secret resource.
  type: Operation
  type: CreateAction
  expects: external_v1_secret
  method: POST
  title: Creates a external_v1_secret resource.
  returns: external_v1_secret

The collection of external_v1_componentEndpoint resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_componentEndpoint
supported operation: Retrieves the collection of external_v1_componentEndpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_componentEndpoint resources.
  returns: Collection

The collection of external_v1_componentGit resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_componentGit
supported operation: Retrieves the collection of external_v1_componentGit resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_componentGit resources.
  returns: Collection

The collection of external_v1_component resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_component
supported operation: Retrieves the collection of external_v1_component resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_component resources.
  returns: Collection

The collection of external_v1_service_component_variable resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_service_component_variable
supported operation: Retrieves the collection of external_v1_service_component_variable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_service_component_variable resources.
  returns: Collection
supported operation: Creates a external_v1_service_component_variable resource.
  type: Operation
  type: CreateAction
  expects: external_v1_service_component_variable
  method: POST
  title: Creates a external_v1_service_component_variable resource.
  returns: external_v1_service_component_variable

The collection of external_v1_template resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_template
supported operation: Retrieves the collection of external_v1_template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_template resources.
  returns: Collection
supported operation: Creates a external_v1_template resource.
  type: Operation
  type: CreateAction
  expects: external_v1_template
  method: POST
  title: Creates a external_v1_template resource.
  returns: external_v1_template

The collection of external_v1_templates_repository resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_templates_repository
supported operation: Retrieves the collection of external_v1_templates_repository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_templates_repository resources.
  returns: Collection

The collection of external_v1_workflow resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: external_v1_workflow
supported operation: Retrieves the collection of external_v1_workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of external_v1_workflow resources.
  returns: Collection

The collection of BillingProduct resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BillingProduct
supported operation: Retrieves the collection of BillingProduct resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BillingProduct resources.
  returns: Collection
supported operation: Retrieves the collection of BillingProduct resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of BillingProduct resources.
  returns: Collection
supported operation: Creates a BillingProduct resource.
  type: Operation
  type: CreateAction
  expects: BillingProduct
  method: POST
  title: Creates a BillingProduct resource.
  returns: BillingProduct

The collection of BillingProfile resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BillingProfile
supported operation: Creates a BillingProfile resource.
  type: Operation
  type: CreateAction
  expects: BillingProfile
  method: POST
  title: Creates a BillingProfile resource.
  returns: BillingProfile
supported operation: Creates a BillingProfile resource.
  type: Operation
  type: CreateAction
  expects: BillingProfile
  method: POST
  title: Creates a BillingProfile resource.
  returns: BillingProfile

The collection of BunnyshellVolumesAddon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BunnyshellVolumesAddon
supported operation: Creates a BunnyshellVolumesAddon resource.
  type: Operation
  type: CreateAction
  expects: BunnyshellVolumesAddon
  method: POST
  title: Creates a BunnyshellVolumesAddon resource.
  returns: BunnyshellVolumesAddon

The collection of CloudProvider resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CloudProvider
supported operation: Retrieves the collection of CloudProvider resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CloudProvider resources.
  returns: Collection
supported operation: Creates a CloudProvider resource.
  type: Operation
  type: CreateAction
  expects: CloudProvider
  method: POST
  title: Creates a CloudProvider resource.
  returns: CloudProvider

The collection of CostTrackingAddon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CostTrackingAddon
supported operation: Creates a CostTrackingAddon resource.
  type: Operation
  type: CreateAction
  expects: CostTrackingAddon
  method: POST
  title: Creates a CostTrackingAddon resource.
  returns: CostTrackingAddon

The collection of Environment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Environment
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  returns: Collection
supported operation: Creates a Environment resource.
  type: Operation
  type: CreateAction
  expects: Environment
  method: POST
  title: Creates a Environment resource.
  returns: Environment
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  returns: Collection
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  returns: Collection
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  deprecated: true
  returns: EnvironmentVariable
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  deprecated: true
  returns: EnvironmentTimeframe

The collection of EnvironmentTimeframe resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EnvironmentTimeframe
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  returns: Collection
supported operation: Creates a EnvironmentTimeframe resource.
  type: Operation
  type: CreateAction
  expects: EnvironmentTimeframe
  method: POST
  title: Creates a EnvironmentTimeframe resource.
  returns: EnvironmentTimeframe
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  returns: Collection

The collection of EnvironmentVariable resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EnvironmentVariable
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  returns: Collection
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  returns: Collection

The collection of Event resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Event
supported operation: Retrieves the collection of Event resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Event resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Event resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Event resources.
  returns: Collection

The collection of GitIntegration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GitIntegration
supported operation: Creates a GitIntegration resource.
  type: Operation
  type: CreateAction
  expects: GitIntegration
  method: POST
  title: Creates a GitIntegration resource.
  returns: GitIntegration
supported operation: Creates a GitIntegration resource.
  type: Operation
  type: CreateAction
  expects: GitIntegration
  method: POST
  title: Creates a GitIntegration resource.
  returns: GitIntegration
supported operation: Creates a GitIntegration resource.
  type: Operation
  type: CreateAction
  expects: GitIntegration
  method: POST
  title: Creates a GitIntegration resource.
  returns: GitIntegration
supported operation: Retrieves the collection of GitIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitIntegration resources.
  returns: Collection
supported operation: Retrieves the collection of GitRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitRepository resources.
  returns: GitRepository

The collection of GitProvider resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GitProvider
supported operation: Creates a GitProvider resource.
  type: Operation
  type: CreateAction
  expects: GitProvider
  method: POST
  title: Creates a GitProvider resource.
  returns: GitProvider

The collection of GitRepository resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GitRepository
supported operation: Retrieves the collection of GitRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitRepository resources.
  returns: Collection
supported operation: Retrieves the collection of GitRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitRepository resources.
  returns: Collection
supported operation: Retrieves the collection of GitRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitRepository resources.
  returns: Collection

The collection of GoldenImage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GoldenImage
supported operation: Retrieves the collection of GoldenImage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GoldenImage resources.
  returns: Collection

The collection of IngressControllerAddon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: IngressControllerAddon
supported operation: Creates a IngressControllerAddon resource.
  type: Operation
  type: CreateAction
  expects: IngressControllerAddon
  method: POST
  title: Creates a IngressControllerAddon resource.
  returns: IngressControllerAddon

The collection of KubernetesDashboardAddon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: KubernetesDashboardAddon
supported operation: Creates a KubernetesDashboardAddon resource.
  type: Operation
  type: CreateAction
  expects: KubernetesDashboardAddon
  method: POST
  title: Creates a KubernetesDashboardAddon resource.
  returns: KubernetesDashboardAddon

The collection of KubernetesIntegration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: KubernetesIntegration
supported operation: Creates a KubernetesIntegration resource.
  type: Operation
  type: CreateAction
  expects: KubernetesIntegration
  method: POST
  title: Creates a KubernetesIntegration resource.
  returns: KubernetesIntegration
supported operation: Creates a KubernetesIntegration resource.
  type: Operation
  type: CreateAction
  expects: KubernetesIntegration
  method: POST
  title: Creates a KubernetesIntegration resource.
  returns: KubernetesIntegration
supported operation: Retrieves the collection of KubernetesIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of KubernetesIntegration resources.
  returns: Collection
supported operation: Retrieves the collection of Addon resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Addon resources.
  returns: Addon

The collection of LogEntry resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LogEntry
supported operation: Retrieves the collection of LogEntry resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LogEntry resources.
  returns: Collection
supported operation: Retrieves the collection of LogEntry resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LogEntry resources.
  returns: Collection
supported operation: Retrieves the collection of LogEntry resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LogEntry resources.
  returns: Collection

The collection of Organization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organization
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  returns: Collection
supported operation: Creates a Organization resource.
  type: Operation
  type: CreateAction
  expects: Organization
  method: POST
  title: Creates a Organization resource.
  returns: Organization
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  deprecated: true
  returns: Project
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  deprecated: true
  returns: Environment
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  deprecated: true
  returns: EnvironmentVariable
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  deprecated: true
  returns: EnvironmentTimeframe
supported operation: Retrieves the collection of ProjectTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectTimeframe resources.
  deprecated: true
  returns: ProjectTimeframe
supported operation: Retrieves the collection of ProjectVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectVariable resources.
  deprecated: true
  returns: ProjectVariable
supported operation: Retrieves the collection of GitIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GitIntegration resources.
  deprecated: true
  returns: GitIntegration
supported operation: Retrieves the collection of KubernetesIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of KubernetesIntegration resources.
  deprecated: true
  returns: KubernetesIntegration
supported operation: Retrieves the collection of Event resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Event resources.
  deprecated: true
  returns: Event
supported operation: Retrieves the collection of OrganizationUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationUser resources.
  deprecated: true
  returns: OrganizationUser
supported operation: Retrieves the collection of RegistryIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of RegistryIntegration resources.
  deprecated: true
  returns: RegistryIntegration
supported operation: Retrieves the collection of TemplatesRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TemplatesRepository resources.
  deprecated: true
  returns: TemplatesRepository
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  deprecated: true
  returns: Template
supported operation: Retrieves the collection of SlackIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SlackIntegration resources.
  deprecated: true
  returns: SlackIntegration
supported operation: Retrieves the collection of TeamsIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamsIntegration resources.
  deprecated: true
  returns: TeamsIntegration

The collection of OrganizationUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrganizationUser
supported operation: Retrieves the collection of OrganizationUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationUser resources.
  returns: Collection
supported operation: Retrieves the collection of OrganizationUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationUser resources.
  returns: Collection

The collection of Project resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Project
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  returns: Collection
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  returns: Collection
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Environment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Environment resources.
  deprecated: true
  returns: Environment
supported operation: Retrieves the collection of EnvironmentVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentVariable resources.
  deprecated: true
  returns: EnvironmentVariable
supported operation: Retrieves the collection of EnvironmentTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EnvironmentTimeframe resources.
  deprecated: true
  returns: EnvironmentTimeframe
supported operation: Retrieves the collection of ProjectTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectTimeframe resources.
  deprecated: true
  returns: ProjectTimeframe
supported operation: Retrieves the collection of ProjectVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectVariable resources.
  deprecated: true
  returns: ProjectVariable

The collection of ProjectTimeframe resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectTimeframe
supported operation: Retrieves the collection of ProjectTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectTimeframe resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectTimeframe resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectTimeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectTimeframe resources.
  returns: Collection
supported operation: Creates a ProjectTimeframe resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a ProjectTimeframe resource.
  returns: ProjectTimeframe
supported operation: Creates a ProjectTimeframe resource.
  type: Operation
  type: CreateAction
  expects: ProjectTimeframe
  method: POST
  title: Creates a ProjectTimeframe resource.
  returns: ProjectTimeframe

The collection of ProjectVariable resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectVariable
supported operation: Retrieves the collection of ProjectVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectVariable resources.
  returns: Collection
supported operation: Creates a ProjectVariable resource.
  type: Operation
  type: CreateAction
  expects: ProjectVariable
  method: POST
  title: Creates a ProjectVariable resource.
  returns: ProjectVariable
supported operation: Retrieves the collection of ProjectVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectVariable resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectVariable resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectVariable resources.
  returns: Collection

The collection of RegistryIntegration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: RegistryIntegration
supported operation: Creates a RegistryIntegration resource.
  type: Operation
  type: CreateAction
  expects: RegistryIntegration
  method: POST
  title: Creates a RegistryIntegration resource.
  returns: RegistryIntegration
supported operation: Retrieves the collection of RegistryIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of RegistryIntegration resources.
  returns: Collection

The collection of RegistryProvider resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: RegistryProvider
supported operation: Retrieves the collection of RegistryProvider resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of RegistryProvider resources.
  returns: Collection

The collection of SlackIntegration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SlackIntegration
supported operation: Creates a SlackIntegration resource.
  type: Operation
  type: CreateAction
  expects: SlackIntegration
  method: POST
  title: Creates a SlackIntegration resource.
  returns: SlackIntegration
supported operation: Creates a SlackIntegration resource.
  type: Operation
  type: CreateAction
  expects: SlackIntegration
  method: POST
  title: Creates a SlackIntegration resource.
  returns: SlackIntegration
supported operation: Retrieves the collection of SlackIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SlackIntegration resources.
  returns: Collection

The collection of TeamsIntegration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TeamsIntegration
supported operation: Creates a TeamsIntegration resource.
  type: Operation
  type: CreateAction
  expects: TeamsIntegration
  method: POST
  title: Creates a TeamsIntegration resource.
  returns: TeamsIntegration
supported operation: Retrieves the collection of TeamsIntegration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamsIntegration resources.
  returns: Collection

The collection of Template resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Template
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Collection
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Collection
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Collection
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Collection

The collection of TemplatesRepository resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TemplatesRepository
supported operation: Retrieves the collection of TemplatesRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TemplatesRepository resources.
  returns: Collection
supported operation: Creates a TemplatesRepository resource.
  type: Operation
  type: CreateAction
  expects: TemplatesRepository
  method: POST
  title: Creates a TemplatesRepository resource.
  returns: TemplatesRepository
supported operation: Retrieves the collection of TemplatesRepository resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TemplatesRepository resources.
  returns: Collection
supported operation: Retrieves the collection of Template resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Template resources.
  returns: Template

The collection of Timeframe resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Timeframe
supported operation: Retrieves the collection of Timeframe resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Timeframe resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: Nothing
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: Nothing
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: Nothing
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: Nothing
supported operation: Retrieves a UserPreferences resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a UserPreferences resource.
  returns: UserPreferences
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  returns: Organization

The collection of Workflow resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Workflow
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  deprecated: true
  returns: Collection

The collection of WorkflowJob resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WorkflowJob
supported operation: Retrieves the collection of WorkflowJob resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowJob resources.
  deprecated: true
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

Retrieves admin/hosting-clusters resource.
type: Operation
type: FindAction
method: GET
title: Retrieves admin/hosting-clusters resource.
returns: admin/hosting-clusters

Replaces the admin/hosting-clusters resource.
type: Operation
type: ReplaceAction
expects: admin/hosting-clusters
method: PUT
title: Replaces the admin/hosting-clusters resource.
returns: admin/hosting-clusters

Deletes the admin/hosting-clusters resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the admin/hosting-clusters resource.
returns: Nothing

SupportedProperty
property: type
title: type
required: false
readable: true
writeable: true

SupportedProperty
property: remoteDevelopmentAllowed
title: remoteDevelopmentAllowed
required: false
readable: true
writeable: true

SupportedProperty
property: autoUpdate
title: autoUpdate
required: false
readable: true
writeable: true

SupportedProperty
property: terminationProtection
title: terminationProtection
required: false
readable: true
writeable: true

SupportedProperty
property: createEphemeralOnPrCreate
title: createEphemeralOnPrCreate
required: false
readable: true
writeable: true

SupportedProperty
property: destroyEphemeralOnPrClose
title: destroyEphemeralOnPrClose
required: false
readable: true
writeable: true

SupportedProperty
property: autoDeployEphemeral
title: autoDeployEphemeral
required: false
readable: true
writeable: true

SupportedProperty
property: kubernetesIntegration
title: kubernetesIntegration
required: false
readable: true
writeable: true

SupportedProperty
property: hostingRegion
title: hostingRegion
required: false
readable: true
writeable: true

SupportedProperty
property: ephemeralKubernetesIntegration
title: ephemeralKubernetesIntegration
required: false
readable: true
writeable: true

SupportedProperty
property: ephemeralHostingRegion
title: ephemeralHostingRegion
required: false
readable: true
writeable: true

SupportedProperty
property: labels
title: labels
required: false
readable: true
writeable: true

SupportedProperty
property: primaryOptions
title: primaryOptions
required: false
readable: true
writeable: true

SupportedProperty
property: templateSettings
title: templateSettings
required: false
readable: true
writeable: true

Retrieves external_v1_environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves external_v1_environment resource.
returns: external_v1_environment

Creates a external_v1_environment resource.
type: Operation
type: CreateAction
expects: external_v1_environment
method: POST
title: Creates a external_v1_environment resource.
returns: external_v1_environment

Creates a external_v1_environment resource.
type: Operation
type: CreateAction
expects: external_v1_environment
method: POST
title: Creates a external_v1_environment resource.
returns: external_v1_environment

Creates a external_v1_environment resource.
type: Operation
type: CreateAction
expects: external_v1_environment
method: POST
title: Creates a external_v1_environment resource.
returns: external_v1_environment

Creates a external_v1_environment resource.
type: Operation
type: CreateAction
expects: external_v1_environment
method: POST
title: Creates a external_v1_environment resource.
returns: external_v1_environment

Creates a external_v1_environment resource.
type: Operation
type: CreateAction
expects: external_v1_environment
method: POST
title: Creates a external_v1_environment resource.
returns: external_v1_environment

Retrieves external_v1_environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves external_v1_environment resource.
returns: external_v1_environment

Retrieves external_v1_environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves external_v1_environment resource.
returns: external_v1_environment

Replaces the external_v1_environment resource.
type: Operation
type: ReplaceAction
expects: external_v1_environment
method: PUT
title: Replaces the external_v1_environment resource.
returns: external_v1_environment

Updates the external_v1_environment resource.
type: Operation
expects: external_v1_environment
method: PATCH
title: Updates the external_v1_environment resource.
returns: external_v1_environment

Updates the external_v1_environment resource.
type: Operation
expects: external_v1_environment
method: PATCH
title: Updates the external_v1_environment resource.
returns: external_v1_environment

Replaces the external_v1_environment resource.
type: Operation
type: ReplaceAction
expects: external_v1_environment
method: PUT
title: Replaces the external_v1_environment resource.
returns: external_v1_environment

Replaces the external_v1_environment resource.
type: Operation
type: ReplaceAction
expects: external_v1_environment
method: PUT
title: Replaces the external_v1_environment resource.
returns: external_v1_environment

SupportedProperty
property: hasFeatureEphemeral
title: hasFeatureEphemeral
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureStaging
title: hasFeatureStaging
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureProduction
title: hasFeatureProduction
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureBuiltinBuildSystem
title: hasFeatureBuiltinBuildSystem
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureRemoteDev
title: hasFeatureRemoteDev
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureWorkers
title: hasFeatureWorkers
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeatureAvailabilityRules
title: hasFeatureAvailabilityRules
required: false
readable: true
writeable: true

SupportedProperty
property: hasFeaturePrivateRegistry
title: hasFeaturePrivateRegistry
required: false
readable: true
writeable: true

Retrieves BillingProduct resource.
type: Operation
type: FindAction
method: GET
title: Retrieves BillingProduct resource.
returns: BillingProduct

SupportedProperty
property: hasFeatureRemoteDev
title: hasFeatureRemoteDev
required: false
readable: true
writeable: false

SupportedProperty
property: hasFeatureBuiltinBuildSystem
title: hasFeatureBuiltinBuildSystem
required: false
readable: true
writeable: false

SupportedProperty
property: stripeProductIds
title: stripeProductIds
required: false
readable: false
writeable: false

SupportedProperty
property: stripePriceIds
title: stripePriceIds
required: false
readable: false
writeable: false

SupportedProperty
property: hasFeatureEphemerals
title: hasFeatureEphemerals
required: false
readable: false
writeable: false

Retrieves BillingProfile resource.
type: Operation
type: FindAction
method: GET
title: Retrieves BillingProfile resource.
returns: BillingProfile

Retrieves BillingProfile resource.
type: Operation
type: FindAction
method: GET
title: Retrieves BillingProfile resource.
returns: BillingProfile

Deletes the BillingProfile resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the BillingProfile resource.
returns: Nothing

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

Creates a BillingProfile resource.
type: Operation
type: CreateAction
expects: BillingProfile
method: POST
title: Creates a BillingProfile resource.
returns: BillingProfile

SupportedProperty
property: componentsSyncStatus
title: componentsSyncStatus
required: false
readable: true
writeable: false

SupportedProperty
property: hasMarkedForDeletionContent
title: hasMarkedForDeletionContent
required: false
readable: true
writeable: false

SupportedProperty
property: ephemeralKubernetesIntegration
title: ephemeralKubernetesIntegration
required: false
readable: true
writeable: false

SupportedProperty
property: ephemeralHostingRegion
title: ephemeralHostingRegion
required: false
readable: true
writeable: false

SupportedProperty
property: createEphemeralOnPrCreate
title: createEphemeralOnPrCreate
required: false
readable: true
writeable: false

SupportedProperty
property: autoDeployEphemeral
title: autoDeployEphemeral
required: false
readable: true
writeable: false

SupportedProperty
property: destroyEphemeralOnPrClose
title: destroyEphemeralOnPrClose
required: false
readable: true
writeable: false

SupportedProperty
property: publicId
title: publicId
required: false
readable: false
writeable: false

SupportedProperty
property: aggregatedOperationStatus
title: aggregatedOperationStatus
required: false
readable: false
writeable: false

SupportedProperty
property: hasDraft
title: hasDraft
required: false
readable: false
writeable: false

SupportedProperty
property: createdByUser
title: createdByUser
required: false
readable: false
writeable: false

SupportedProperty
property: environmentVariables
title: environmentVariables
required: false
readable: false
writeable: false
description: Add fetch=EXTRA_LAZY to force $environmentVariables->count() to run a COUNT sql query, not a SELECT + hydration (which includes Vault) + count()

SupportedProperty
property: timeframes
title: timeframes
required: false
readable: false
writeable: false

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Nothing

Deletes the Environment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Deletes the Environment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Nothing

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Nothing

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Deletes the Environment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Environment resource.
returns: Nothing

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Replaces the Environment resource.
type: Operation
type: ReplaceAction
expects: Environment
method: PUT
title: Replaces the Environment resource.
returns: Environment

Deletes the Environment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Environment resource.
returns: Nothing

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Deletes the Environment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Environment resource.
returns: Nothing

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Retrieves Environment resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Environment resource.
returns: Environment

Creates a Environment resource.
type: Operation
type: CreateAction
expects: Environment
method: POST
title: Creates a Environment resource.
returns: Environment

Retrieves the collection of EnvironmentVariable resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentVariable resources.
deprecated: true
returns: EnvironmentVariable

Retrieves the collection of EnvironmentTimeframe resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentTimeframe resources.
deprecated: true
returns: EnvironmentTimeframe

SupportedProperty
property: latestWorkflow
title: latestWorkflow
required: false
readable: true
writeable: false

SupportedProperty
property: hasOutdatedConfiguration
title: hasOutdatedConfiguration
required: false
readable: false
writeable: false

SupportedProperty
property: clusterHasMultipleIntegrations
title: clusterHasMultipleIntegrations
required: false
readable: false
writeable: false

SupportedProperty
property: addonCostTrackingIsDataCollectionSuspended
title: addonCostTrackingIsDataCollectionSuspended
required: false
readable: false
writeable: false

SupportedProperty
property: addonCostTrackingDataCollectionErrorAt
title: addonCostTrackingDataCollectionErrorAt
required: false
readable: false
writeable: false

Retrieves KubernetesIntegration resource.
type: Operation
type: FindAction
method: GET
title: Retrieves KubernetesIntegration resource.
returns: KubernetesIntegration

Replaces the KubernetesIntegration resource.
type: Operation
type: ReplaceAction
expects: KubernetesIntegration
method: PUT
title: Replaces the KubernetesIntegration resource.
returns: KubernetesIntegration

Replaces the KubernetesIntegration resource.
type: Operation
type: ReplaceAction
expects: Nothing
method: PUT
title: Replaces the KubernetesIntegration resource.
returns: KubernetesIntegration

Replaces the KubernetesIntegration resource.
type: Operation
type: ReplaceAction
expects: Nothing
method: PUT
title: Replaces the KubernetesIntegration resource.
returns: KubernetesIntegration

Creates a KubernetesIntegration resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a KubernetesIntegration resource.
returns: KubernetesIntegration

Retrieves the collection of Addon resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Addon resources.
returns: Addon

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Nothing

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
deprecated: true
returns: Organization

Deletes the Organization resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Organization resource.
returns: Nothing

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Nothing

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Replaces the Organization resource.
type: Operation
type: ReplaceAction
expects: Organization
method: PUT
title: Replaces the Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Organization resource.
returns: Nothing

Retrieves Organization resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Creates a Organization resource.
type: Operation
type: CreateAction
expects: Organization
method: POST
title: Creates a Organization resource.
returns: Organization

Retrieves the collection of Project resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Project resources.
deprecated: true
returns: Project

Retrieves the collection of Environment resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Environment resources.
deprecated: true
returns: Environment

Retrieves the collection of EnvironmentVariable resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentVariable resources.
deprecated: true
returns: EnvironmentVariable

Retrieves the collection of EnvironmentTimeframe resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentTimeframe resources.
deprecated: true
returns: EnvironmentTimeframe

Retrieves the collection of ProjectTimeframe resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of ProjectTimeframe resources.
deprecated: true
returns: ProjectTimeframe

Retrieves the collection of ProjectVariable resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of ProjectVariable resources.
deprecated: true
returns: ProjectVariable

Retrieves the collection of GitIntegration resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of GitIntegration resources.
deprecated: true
returns: GitIntegration

Retrieves the collection of KubernetesIntegration resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of KubernetesIntegration resources.
deprecated: true
returns: KubernetesIntegration

Retrieves the collection of Event resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Event resources.
deprecated: true
returns: Event

Retrieves the collection of OrganizationUser resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of OrganizationUser resources.
deprecated: true
returns: OrganizationUser

Retrieves the collection of RegistryIntegration resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of RegistryIntegration resources.
deprecated: true
returns: RegistryIntegration

Retrieves the collection of TemplatesRepository resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of TemplatesRepository resources.
deprecated: true
returns: TemplatesRepository

Retrieves the collection of Template resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Template resources.
deprecated: true
returns: Template

Retrieves the collection of SlackIntegration resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of SlackIntegration resources.
deprecated: true
returns: SlackIntegration

Retrieves the collection of TeamsIntegration resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of TeamsIntegration resources.
deprecated: true
returns: TeamsIntegration

Retrieves the collection of Environment resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of Environment resources.
deprecated: true
returns: Environment

Retrieves the collection of EnvironmentVariable resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentVariable resources.
deprecated: true
returns: EnvironmentVariable

Retrieves the collection of EnvironmentTimeframe resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of EnvironmentTimeframe resources.
deprecated: true
returns: EnvironmentTimeframe

Retrieves the collection of ProjectTimeframe resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of ProjectTimeframe resources.
deprecated: true
returns: ProjectTimeframe

Retrieves the collection of ProjectVariable resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of ProjectVariable resources.
deprecated: true
returns: ProjectVariable

SupportedProperty
property: duration
title: duration
required: false
readable: true
writeable: false

SupportedProperty
property: hashIDOrThrow
title: hashIDOrThrow
required: false
readable: true
writeable: false

SupportedProperty
property: aborted
title: aborted
required: false
readable: true
writeable: false

Retrieves Workflow resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Workflow resource.
returns: Workflow

Creates a Workflow resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a Workflow resource.
returns: Workflow

Retrieves Workflow resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Workflow resource.
returns: Workflow

Retrieves WorkflowJob resource.
type: Operation
type: FindAction
method: GET
title: Retrieves WorkflowJob resource.
returns: WorkflowJob

Retrieves WorkflowJob resource.
type: Operation
type: FindAction
method: GET
title: Retrieves WorkflowJob resource.
returns: WorkflowJob

SupportedProperty
property: The collection of Event resources
title: The collection of Event resources
readable: true
writeable: false

SupportedProperty
property: The collection of GitIntegration resources
title: The collection of GitIntegration resources
readable: true
writeable: false

SupportedProperty
property: The collection of GitProvider resources
title: The collection of GitProvider resources
readable: true
writeable: false

SupportedProperty
property: The collection of GitRepository resources
title: The collection of GitRepository resources
readable: true
writeable: false

SupportedProperty
property: The collection of GoldenImage resources
title: The collection of GoldenImage resources
readable: true
writeable: false

SupportedProperty
property: The collection of IngressControllerAddon resources
title: The collection of IngressControllerAddon resources
readable: true
writeable: false

SupportedProperty
property: The collection of KubernetesDashboardAddon resources
title: The collection of KubernetesDashboardAddon resources
readable: true
writeable: false

SupportedProperty
property: The collection of KubernetesIntegration resources
title: The collection of KubernetesIntegration resources
readable: true
writeable: false

SupportedProperty
property: The collection of LogEntry resources
title: The collection of LogEntry resources
readable: true
writeable: false

SupportedProperty
property: The collection of Organization resources
title: The collection of Organization resources
readable: true
writeable: false

SupportedProperty
property: The collection of OrganizationUser resources
title: The collection of OrganizationUser resources
readable: true
writeable: false

SupportedProperty
property: The collection of Project resources
title: The collection of Project resources
readable: true
writeable: false

SupportedProperty
property: The collection of ProjectTimeframe resources
title: The collection of ProjectTimeframe resources
readable: true
writeable: false

SupportedProperty
property: The collection of ProjectVariable resources
title: The collection of ProjectVariable resources
readable: true
writeable: false

SupportedProperty
property: The collection of RegistryIntegration resources
title: The collection of RegistryIntegration resources
readable: true
writeable: false

SupportedProperty
property: The collection of RegistryProvider resources
title: The collection of RegistryProvider resources
readable: true
writeable: false

SupportedProperty
property: The collection of SlackIntegration resources
title: The collection of SlackIntegration resources
readable: true
writeable: false

SupportedProperty
property: The collection of TeamsIntegration resources
title: The collection of TeamsIntegration resources
readable: true
writeable: false

SupportedProperty
property: The collection of Template resources
title: The collection of Template resources
readable: true
writeable: false

SupportedProperty
property: The collection of TemplatesRepository resources
title: The collection of TemplatesRepository resources
readable: true
writeable: false

SupportedProperty
property: The collection of Timeframe resources
title: The collection of Timeframe resources
readable: true
writeable: false

SupportedProperty
property: The collection of User resources
title: The collection of User resources
readable: true
writeable: false

SupportedProperty
property: The collection of Workflow resources
title: The collection of Workflow resources
readable: true
writeable: false

SupportedProperty
property: The collection of WorkflowJob resources
title: The collection of WorkflowJob resources
readable: true
writeable: false

The API entrypoint.
type: Operation
method: GET
returns: EntryPoint