services_get_deployments: Get details about a Service deployment

In civis: R Client for the 'Civis Platform API'

Get details about a Service deployment

Description

Get details about a Service deployment

Usage

services_get_deployments(service_id, deployment_id)

Arguments

service_id	integer required. The ID of the owning Service
deployment_id	integer required. The ID for this deployment

Value

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

civis documentation built on Aug. 30, 2025, 1:08 a.m.