services_patch {civis}

Update some attributes of this Service

Description

Update some attributes of this Service

Usage

services_patch(
  id,
  name = NULL,
  description = NULL,
  docker_image_name = NULL,
  docker_image_tag = NULL,
  schedule = NULL,
  replicas = NULL,
  max_replicas = NULL,
  instance_type = NULL,
  memory = NULL,
  cpu = NULL,
  credentials = NULL,
  permission_set_id = NULL,
  git_repo_url = NULL,
  git_repo_ref = NULL,
  git_path_dir = NULL,
  environment_variables = NULL,
  notifications = NULL,
  partition_label = NULL
)

Arguments

id

integer required. The ID for this Service.

name

string optional. The name of this Service.

description

string optional. The description of this Service.

docker_image_name

string optional. The name of the docker image to pull from DockerHub.

docker_image_tag

string optional. The tag of the docker image to pull from DockerHub (default: latest).

schedule

list optional. A list containing the following elements:

• runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.

• recurrences array, List of day-hour combinations this item is scheduled for

replicas

integer optional. The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.

max_replicas

integer optional. The maximum number of Service replicas to deploy. Defining this field enables autoscaling.

instance_type

string optional. The EC2 instance type to deploy to.

memory

integer optional. The amount of memory allocated to each replica of the Service.

cpu

integer optional. The amount of cpu allocated to each replica of the the Service.

credentials

array optional. A list of credential IDs to pass to the Service.

permission_set_id

integer optional. The ID of the associated permission set, if any.

git_repo_url

string optional. The url for the git repo where the Service code lives.

git_repo_ref

string optional. The git reference to use when pulling code from the repo.

git_path_dir

string optional. The path to the Service code within the git repo. If unspecified, the root directory will be used.

environment_variables

list optional. Environment Variables to be passed into the Service.

notifications

list optional. A list containing the following elements:

• failureEmailAddresses array, Addresses to notify by e-mail when the service fails.

• failureOn boolean, If failure email notifications are on

partition_label

string optional. The partition label used to run this object.

Value

A list containing the following elements:

id

integer, The ID for this Service.

name

string, The name of this Service.

description

string, The description of this Service.

user

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

type

string, The type of this Service

dockerImageName

string, The name of the docker image to pull from DockerHub.

dockerImageTag

string, The tag of the docker image to pull from DockerHub (default: latest).

schedule

list, A list containing the following elements:

• runtimePlan string, Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.

• recurrences array, List of day-hour combinations this item is scheduled for

timeZone

string,

replicas

integer, The number of Service replicas to deploy. When maxReplicas is set, this field defines the minimum number of replicas to deploy.

maxReplicas

integer, The maximum number of Service replicas to deploy. Defining this field enables autoscaling.

instanceType

string, The EC2 instance type to deploy to.

memory

integer, The amount of memory allocated to each replica of the Service.

cpu

integer, The amount of cpu allocated to each replica of the the Service.

createdAt

string,

updatedAt

string,

credentials

array, A list of credential IDs to pass to the Service.

permissionSetId

integer, The ID of the associated permission set, if any.

gitRepoUrl

string, The url for the git repo where the Service code lives.

gitRepoRef

string, The git reference to use when pulling code from the repo.

gitPathDir

string, The path to the Service code within the git repo. If unspecified, the root directory will be used.

reportId

integer, The ID of the associated report.

currentDeployment

list, A list containing the following elements:

• deploymentId integer, The ID for this deployment.

• userId integer, The ID of the owner.

• host string, Domain of the deployment.

• name string, Name of the deployment.

• dockerImageName string, The name of the docker image to pull from DockerHub.

• dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest).

• displayUrl string, A signed URL for viewing the deployed item.

• instanceType string, The EC2 instance type requested for the deployment.

• memory integer, The memory allocated to the deployment, in MB.

• cpu integer, The cpu allocated to the deployment, in millicores.

• state string, The state of the deployment.

• stateMessage string, A detailed description of the state.

• maxMemoryUsage number, If the deployment has finished, the maximum amount of memory used during the deployment, in MB.

• maxCpuUsage number, If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.

• createdAt string,

• updatedAt string,

• serviceId integer, The ID of owning Service

currentUrl

string, The URL that the service is hosted at.

environmentVariables

list, Environment Variables to be passed into the Service.

notifications

list, A list containing the following elements:

• failureEmailAddresses array, Addresses to notify by e-mail when the service fails.

• failureOn boolean, If failure email notifications are on

partitionLabel

string, The partition label used to run this object.

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".

archived

string, The archival status of the requested item(s).

hidden

boolean, The hidden status of the item.