Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This endpoint is used to create, update, search or delete organizations information inside Terrakube.
You need to be part of the administrator Active Directory Group to work with this endpoint
The default group is handled using the Spring Boot property
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete global variables information inside a Terrakube organizations, this variables will be injected inside the jobs, workspace variables have priority over global variables if the same name is used.
You need to be part of the administrator Active Directory Group to work with this endpoint
For a complete list of organization operation please visit the OpenAPI specification
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
data.type
string
Should be "organization"
data.attributes.name
string
Unique name in Terrakube
data.attributes.description
string
Free description
data.type
string
Should be "variable"
data.attributes.key
string
Unique variable name
data.attributes.value
string
Key value
data.attributes.sensitive
boolean
To hide the value when the output is sensitive
data.attributes.hcl
boolean
Terraform HCL variable type
data.attributes.category
string
Variable type could be TERRAFORM or ENV (Environment Variable)
data.attributes.description
string
Free text
This endpoint is used to create, update, search or delete teams information inside a Terrakube organization.
You need to be part of the administrator Active Directory Group to work with this endpoint
The default group is handled using the Spring Boot property
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete workspace information inside a Terrakube organization.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube organization
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete variables information inside a Terrakube workspace.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace
For a complete list of organization operation please visit the OpenAPI specification
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|
For a complete list of organization operation please visit the
data.type
string
Should be "team"
data.attributes.name
string
Active Directory Group name
data.attributes.manageWorkspace
boolean
Enable Create/Update/Delete Workspaces for a Team
data.attributes.manageModule
boolean
Enable Create/Update/Delete Workspaces for a Team
data.attributes.manageProvider
boolean
Enable Create/Update/Delete Terraform Provider for a Team
data.attributes.manageVcs
boolean
Enable Create/Update/Delete VCS connection for private GIT Repositories for a Team
data.attributes.manageTemplates
boolean
Enable Create/Update/Delete Templates for a Team
data.type
string
Should be "workspace"
data.attributes.name
string
Unique workspace for an Terrakube organization
data.attributes.branch
boolean
Git branch to be used
data.attributes.source
boolean
Git repository to be used
data.attributes.terraformVersion
boolean
Terraform version to run the workspace
data.relationships.vcs.data.type
string
Should be "vcs" (OPTIONAL)
data.relationships.vcs.data.type
string
Should be the VCS Connection Id (OPTIONAL)
data.type
string
Should be "variable"
data.attributes.key
string
Unique variable name
data.attributes.value
string
Key value
data.attributes.sensitive
boolean
To hide the value when the output is sensitive
data.attributes.hcl
boolean
Terraform HCL variable type
data.attributes.category
string
Variable type could be TERRAFORM or ENV (Environment Variable)
data.attributes.description
string
Free text
data.type | string | Should be "history" |
data.attributes.output | string | Unique variable name |
This endpoint is used to create, update, search or delete teamplates inside an organization.
To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete schedules for a particular workspace inside an organization, this is useful when you need to create schedule task or running jobs in a particular time.
To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete jobs for a particular Terrakube workspace.
To use this endpoint you need to create a Terrakube workspace.
To better understand Terrakube Configuration Language job templates please refer to the following GitHub repository.
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete vcs (version control system) information inside a Terrakube organization so you can connect to private git repositories to run modules and workspaces
To use this endpoint you should have "manageVcs" access at team level and a Terrakube Organization
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|
For a complete list of organization operation please visit the
Path | Type | Description |
---|
For a complete list of organization operation please visit the
Path | Type | Description |
---|
For a complete list of organization operation please visit the
data.type
string
Should be "template"
data.attributes.tcl
string
Terraform Configuration Language job template
data.attribute.name
string
Template name
data.attribute.description
string
Template description
data.attribute.version
string
Template version
data.type
string
Should be "template"
data.attributes.cron
string
Cron expression to schedule a job inside a workspace. For more information please visit Quartz documentation.
data.attributes.tcl
string
Terrakube configuration language in base64
data.attributes.templateReference
string
Terrakube template id
data.type
string
Should be "job"
data.attributes.tcl
string
Terraform Configuration Language job template
data.attributes.templateReference
string
Terrakube template id to use when running the job
data.relationships.workspace.data.type
string
Should be "workspace"
data.relationships.workspace.data.Id
string
Should be the VCS Workspace Id (OPTIONAL)
data.type | string | Should be "workspace" |
data.attributes.name | string | Unique workspace for an Terrakube organization |
data.attributes.branch | boolean | Git branch to be used |
data.attributes.source | boolean | Git repository to be used |
data.attributes.terraformVersion | boolean | Terraform version to run the workspace |
data.relationships.vcs.data.type | string | Should be "vcs" (OPTIONAL) |
data.relationships.vcs.data.type | string | Should be the VCS Connection Id (OPTIONAL) |
data.type | string | Should be "vcs" |
data.attributes.name | string | Unique vcs name for an Terrakube organization |
data.attributes.description | string | Free text for description |
data.attributes.vcsType | string | Supported values: GITHUB, GITLAB, BITBUCKET, AZURE_DEVOPS |
data.attributes.clientID | string | Client Application Id |
data.attributes.clientSecret | string | Client Application secret |
data.type | string | Should be "step" |
data.attributes.output | string | URL with the output for the step |
data.attributes.status | string | Step status(pending or completed) |
data.attributes.stepNumber | int | A job can have several steps, this field is used to identity the order for the execution |
Work in progress
Path | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Path | Type | Description |
---|---|---|
Path | Type | Description |
---|
days
string
Numbere of days for the token to be valid
description
string
Some sample description for the token
days*
int
Number of days
description*
String
Token description
days
String
Number of days for the token to be valid
hours
String
Number of hours the token will be valid
minutes
String
Number of minutes the token will be valid
description
string
Some sample description for the token
days*
int
Number of days
description*
String
Token description
group
String
Team name
data.type
string
Should be "ssh"
data.attributes.name
string
Unique ssh key name for an Terrakube organization
data.attributes.description
string
Free text for description
data.attributes.privateKey
string
SSH Key content
data.attributes.sshType
string
rsa or ed25519
data.type | string | Should be "agent" |
data.attributes.name | string | Agent pool name |
data.attributes.description | string | agent pool description |
data.attributes.url | string |
URL where the executor component will be available. Example: