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 variables information inside a Terrakube workspace.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace
| Path | Type | Description |
|---|---|---|
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
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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 "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)
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
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to see terraform states changes over time for a Terrakube workspace.
To use this endpoint you should have "manageWorkspace" access at team level and a Terrakube workspace
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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
| Path | Type | Description |
|---|---|---|
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
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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 "history"
data.attributes.output
string
Unique variable name
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
Work in progress
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.
| Path | Type | Description |
|---|---|---|
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.
| Path | Type | Description |
|---|---|---|
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 see the output for a job step.
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete teamplates inside an organization.
| Path | Type | Description |
|---|---|---|
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 |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
This endpoint is used to create, update, search or delete module information inside a Terrakube organization.
To use this endpoint you should have "manageModule" access at team level and a Terrakube organization
| Path | Type | Description |
|---|---|---|
For a complete list of organization operation please visit the OpenAPI specification
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 "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 "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
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 "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 "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)
| Name | Type | 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
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
data.type | string | Should be "agent" |
data.attributes.name | string | Agent pool name |
data.attributes.description | string | agent pool description |
data.attributes.url | string |
Deletes an instance of type workspace
organization Identifier
workspace Identifier
Successful response
Deletes an instance of type team
organization Identifier
team Identifier
Successful response
Deletes an instance of type job
workspace Identifier
job Identifier
Successful response
Deletes an instance of type module
organization Identifier
module Identifier
Successful response
Modifies an instance of type workspace
organization Identifier
workspace Identifier
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Successful response
Modifies an instance of type team
organization Identifier
team Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Modifies an instance of type job
workspace Identifier
job Identifier
Successful response
Modifies an instance of type module
organization Identifier
module Identifier
Successful response
Creates an item of type module and adds it to module
organization Identifier
Successful response
Creates an item of type job and adds it to job
workspace Identifier
Successful response
Creates an item of type team and adds it to team
organization Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Returns an instance of type module
organization Identifier
module Identifier
Selects the set of module fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Included resources
Returns an instance of type team
organization Identifier
team Identifier
Selects the set of team fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Included resources
Returns an instance of type job
workspace Identifier
job Identifier
Selects the set of job fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Included resources
Creates an item of type workspace and adds it to workspace
organization Identifier
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Successful response
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Returns an instance of type workspace
organization Identifier
workspace Identifier
Selects the set of workspace fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Create Permissions : (team manage workspace) Delete Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Read Permissions : (team view workspace) Update Permissions : (team manage workspace)
Included resources
URL where the executor component will be available. Example:
Deletes an instance of type schedule
workspace Identifier
schedule Identifier
Successful response
Deletes an instance of type template
organization Identifier
template Identifier
Successful response
Modifies an instance of type schedule
workspace Identifier
schedule Identifier
Successful response
Modifies an instance of type template
organization Identifier
template Identifier
Create Permissions : (team manage template) Delete Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Successful response
Creates an item of type schedule and adds it to schedule
workspace Identifier
Successful response
Returns an instance of type schedule
workspace Identifier
schedule Identifier
Selects the set of schedule fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Included resources
Creates an item of type template and adds it to template
organization Identifier
Create Permissions : (team manage template) Delete Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Successful response
Create Permissions : (team manage template) Delete Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Returns an instance of type template
organization Identifier
template Identifier
Selects the set of template fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Create Permissions : (team manage template) Delete Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Read Permissions : (team view template OR user is a service) Update Permissions : (team manage template)
Included resources
Returns the relationship globalvar
organization Identifier
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of globalvar fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of globalvar using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Included resources
Deletes an instance of type vcs
workspace Identifier
vcs Identifier
Successful response
Deletes an instance of type vcs
organization Identifier
vcs Identifier
Successful response
Modifies an instance of type vcs
organization Identifier
vcs Identifier
Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Successful response
Creates an item of type variable and adds it to variable
workspace Identifier
Read Permissions : (service read secret)
Successful response
Read Permissions : (service read secret)
Creates an item of type vcs and adds it to vcs
organization Identifier
Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Successful response
Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Modifies an instance of type vcs
workspace Identifier
vcs Identifier
Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Successful response
Returns an instance of type variable
workspace Identifier
variable Identifier
Selects the set of variable fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Read Permissions : (service read secret)
Included resources
Returns an instance of type vcs
organization Identifier
vcs Identifier
Selects the set of vcs fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Create Permissions : (team manage vcs) Delete Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (service read vcs secret) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Read Permissions : (team view vcs OR user is a service) Update Permissions : (team manage vcs)
Included resources
Returns an instance of type step
step Identifier
Selects the set of step fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Successful response
Included resources
Returns the relationship history
workspace Identifier
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of history fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of history using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Included resources
Deletes an instance of type organization
organization Identifier
Successful response
Modifies an instance of type organization
organization Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Successful response
Creates an item of type organization
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Returns the collection of type organization
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of organization fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of organization using a 'disjoint' RSQL expression
Filters the collection of organization using a 'joined' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user is a superuser )
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Read Permissions : (user belongs organization) Update Permissions : (user belongs organization)
Included resources
Deletes an instance of type globalvar
organization Identifier
globalvar Identifier
Successful response
Modifies an instance of type globalvar
organization Identifier
globalvar Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Creates an item of type globalvar and adds it to globalvar
organization Identifier
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Successful response
Create Permissions : (user is a superuser) Delete Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Update Permissions : (admin update secret)
Read Permissions : (admin read secret) Update Permissions : (user is a superuser)
Update Permissions : (user is a superuser)
Deletes an instance of type ssh
organization Identifier
ssh Identifier
Successful response
Modifies an instance of type ssh
organization Identifier
ssh Identifier
Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (read private key) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Successful response
Creates an item of type ssh and adds it to ssh
organization Identifier
Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (read private key) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Successful response
Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (read private key) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Returns the relationship ssh
organization Identifier
Sorts the collection on the selected attributes. A prefix of '-' sorts descending
Selects the set of ssh fields that should be returned in the result.
Selects the set of relationships that should be expanded as a compound document in the result.
Filters the collection of ssh using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
Create Permissions : (team manage ssh) Delete Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (read private key) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Read Permissions : (team view ssh) Update Permissions : (team manage ssh)
Included resources