Module write
Source - AddUserToUserGroup
- Admin only. Add a user to a user group. Response: UserGroup
- CopyAlerter
- Creates a new alerter with given
name and the configuration
of the alerter at the given id. Response: Alerter. - CopyBuild
- Creates a new build with given
name and the configuration
of the build at the given id. Response: Build. - CopyBuilder
- Creates a new builder with given
name and the configuration
of the builder at the given id. Response: Builder - CopyDeployment
- Creates a new deployment with given
name and the configuration
of the deployment at the given id. Response: Deployment - CopyProcedure
- Creates a new procedure with given
name and the configuration
of the procedure at the given id. Response: Procedure. - CopyRepo
- Creates a new repo with given
name and the configuration
of the repo at the given id. Response: Repo. - CopyResourceSync
- Creates a new sync with given
name and the configuration
of the sync at the given id. Response: ResourceSync. - CopyServerTemplate
- Creates a new server template with given
name and the configuration
of the server template at the given id. Response: ServerTemplate - CopyStack
- Creates a new stack with given
name and the configuration
of the stack at the given id. Response: Stack. - CreateAlerter
- Create an alerter. Response: Alerter.
- CreateApiKeyForServiceUser
- Admin only method to create an api key for a service user.
Response: CreateApiKeyResponse.
- CreateBuild
- Create a build. Response: Build.
- CreateBuildWebhook
- Create a webhook on the github repo attached to the build
passed in request. Response: CreateBuildWebhookResponse
- CreateBuilder
- Create a builder. Response: Builder.
- CreateDeployment
- Create a deployment. Response: Deployment.
- CreateDockerRegistryAccount
- Admin only. Create a docker registry account.
Response: DockerRegistryAccount.
- CreateGitProviderAccount
- Admin only. Create a git provider account.
Response: GitProviderAccount.
- CreateNetwork
- Create a docker network on the server.
Respone: Update
- CreateProcedure
- Create a procedure. Response: Procedure.
- CreateRepo
- Create a repo. Response: Repo.
- CreateRepoWebhook
- Create a webhook on the github repo attached to the (monitor) repo
passed in request. Response: CreateRepoWebhookResponse
- CreateResourceSync
- Create a sync. Response: ResourceSync.
- CreateServer
- Create a server. Response: Server.
- CreateServerTemplate
- Create a server template. Response: ServerTemplate.
- CreateServiceUser
- Admin only. Create a service user.
Response: User.
- CreateStack
- Create a stack. Response: Stack.
- CreateStackWebhook
- Create a webhook on the github repo attached to the stack
passed in request. Response: CreateStackWebhookResponse
- CreateSyncWebhook
- Create a webhook on the github repo attached to the sync
passed in request. Response: CreateSyncWebhookResponse
- CreateTag
- Create a tag. Response: Tag.
- CreateUserGroup
- Admin only. Create a user group. Response: UserGroup
- CreateVariable
- Admin only. Create variable. Response: Variable.
- DeleteAlerter
- Deletes the alerter at the given id, and returns the deleted alerter.
Response: Alerter
- DeleteApiKeyForServiceUser
- Admin only method to delete an api key for a service user.
Response: NoData.
- DeleteBuild
- Deletes the build at the given id, and returns the deleted build.
Response: Build
- DeleteBuildWebhook
- Delete a webhook on the github repo attached to the build
passed in request. Response: CreateBuildWebhookResponse
- DeleteBuilder
- Deletes the builder at the given id, and returns the deleted builder.
Response: Builder
- DeleteDeployment
- Deletes the deployment at the given id, and returns the deleted deployment.
Response: Deployment.
- DeleteDockerRegistryAccount
- Admin only. Delete a docker registry account.
Response: DockerRegistryAccount.
- DeleteGitProviderAccount
- Admin only. Delete a git provider account.
Response: [User].
- DeleteNetwork
- Delete a docker network.
Response: Update
- DeleteProcedure
- Deletes the procedure at the given id, and returns the deleted procedure.
Response: Procedure
- DeleteRepo
- Deletes the repo at the given id, and returns the deleted repo.
Response: Repo
- DeleteRepoWebhook
- Delete the webhook on the github repo attached to the (monitor) repo
passed in request. Response: DeleteRepoWebhookResponse
- DeleteResourceSync
- Deletes the sync at the given id, and returns the deleted sync.
Response: ResourceSync
- DeleteServer
- Deletes the server at the given id, and returns the deleted server.
Response: Server
- DeleteServerTemplate
- Deletes the server template at the given id, and returns the deleted server template.
Response: ServerTemplate
- DeleteStack
- Deletes the stack at the given id, and returns the deleted stack.
Response: Stack
- DeleteStackWebhook
- Delete the webhook on the github repo attached to the stack
passed in request. Response: DeleteStackWebhookResponse
- DeleteSyncWebhook
- Delete the webhook on the github repo attached to the sync
passed in request. Response: DeleteSyncWebhookResponse
- DeleteTag
- Delete a tag, and return the deleted tag. Response: Tag.
- DeleteUserGroup
- Admin only. Delete a user group. Response: UserGroup
- DeleteVariable
- Admin only. Delete a variable. Response: Variable.
- RefreshBuildCache
- Trigger a refresh of the cached latest hash and message.
- RefreshRepoCache
- Trigger a refresh of the cached latest hash and message.
- RefreshResourceSyncPending
- Trigger a refresh of the computed diff logs for view.
- RefreshStackCache
- Trigger a refresh of the cached compose file contents.
Refreshes:
- RemoveUserFromUserGroup
- Admin only. Remove a user from a user group. Response: UserGroup
- RenameDeployment
- Rename the deployment at id to the given name. Response: Update.
- RenameServer
- Rename the server at id to the given name. Response: Update.
- RenameStack
- Rename the stack at id to the given name. Response: Update.
- RenameTag
- Rename a tag at id. Response: Tag.
- RenameUserGroup
- Admin only. Rename a user group. Response: UserGroup
- SetUsersInUserGroup
- Admin only. Completely override the user in the group.
Response: UserGroup
- UpdateAlerter
- Update the alerter at the given id, and return the updated alerter. Response: Alerter.
- UpdateBuild
- Update the build at the given id, and return the updated build.
Response: Build.
- UpdateBuilder
- Update the builder at the given id, and return the updated builder.
Response: Builder.
- UpdateDeployment
- Update the deployment at the given id, and return the updated deployment.
Response: Deployment.
- UpdateDescription
- Update a resources description.
Response: NoData.
- UpdateDockerRegistryAccount
- Admin only. Update a docker registry account.
Response: DockerRegistryAccount.
- UpdateGitProviderAccount
- Admin only. Update a git provider account.
Response: GitProviderAccount.
- UpdatePermissionOnResourceType
- Admin only. Update a user or user groups base permission level on a resource type.
Response: NoData.
- UpdatePermissionOnTarget
- Admin only. Update a user or user groups permission on a resource.
Response: NoData.
- UpdateProcedure
- Update the procedure at the given id, and return the updated procedure.
Response: Procedure.
- UpdateRepo
- Update the repo at the given id, and return the updated repo.
Response: Repo.
- UpdateResourceSync
- Update the sync at the given id, and return the updated sync.
Response: ResourceSync.
- UpdateServer
- Update the server at the given id, and return the updated server.
Response: Server.
- UpdateServerTemplate
- Update the server template at the given id, and return the updated server template.
Response: ServerTemplate.
- UpdateServiceUserDescription
- Admin only. Update a service user’s description.
Response: User.
- UpdateStack
- Update the stack at the given id, and return the updated stack.
Response: Stack.
- UpdateTagsOnResource
- Update the tags on a resource.
Response: NoData
- UpdateUserBasePermissions
- Admin only. Update a user’s “base” permissions, eg. “enabled”.
Response: NoData.
- UpdateVariableDescription
- Admin only. Update variable. Response: Variable.
- UpdateVariableValue
- Admin only. Update variable. Response: Variable.
- RepoWebhookAction
- StackWebhookAction
- SyncWebhookAction
- MonitorWriteRequest
- CopyProcedureResponse
- CreateApiKeyForServiceUserResponse
- CreateBuildWebhookResponse
- CreateDockerRegistryAccountResponse
- CreateGitProviderAccountResponse
- CreateProcedureResponse
- CreateRepoWebhookResponse
- CreateServiceUserResponse
- CreateStackWebhookResponse
- CreateSyncWebhookResponse
- CreateVariableResponse
- DeleteApiKeyForServiceUserResponse
- DeleteBuildWebhookResponse
- DeleteDockerRegistryAccountResponse
- DeleteGitProviderAccountResponse
- DeleteProcedureResponse
- DeleteRepoWebhookResponse
- DeleteStackWebhookResponse
- DeleteSyncWebhookResponse
- DeleteVariableResponse
- UpdateDescriptionResponse
- UpdateDockerRegistryAccountResponse
- UpdateGitProviderAccountResponse
- UpdatePermissionOnResourceTypeResponse
- UpdatePermissionOnTargetResponse
- UpdateProcedureResponse
- UpdateServiceUserDescriptionResponse
- UpdateTagsOnResourceResponse
- UpdateUserBasePermissionsResponse
- UpdateVariableDescriptionResponse
- UpdateVariableValueResponse