Environment

Update an environment

Update the details of a single existing environment.

patch/projects/{projectId}/environments/{environmentId}

Request

Base URL
https://api.upsun.com
Auth
OAuth 2
Authorization codehttps://auth.api.platform.sh/oauth2/authorize
Token URLhttps://auth.api.platform.sh/oauth2/token
TypeScript
https://skmtc.dev/upsun/apis/upsun-com-rest-api/docs/projects/:projectId/environments/:environmentId/patch.ts
A function with typed inputs. Its response is checked against the schema.

projectIdstring required

environmentIdstring required

namestring

The name of the environment

titlestring

The title of the environment

attributesobject

Arbitrary attributes attached to this resource

type'development' | 'production' | 'staging'

The type of environment (production, staging or development), if not provided, a default will be calculated

parentstring nullable

The name of the parent environment

clone_parent_on_createboolean

Clone data when creating that environment

enable_smtpboolean

Whether to configure SMTP for this environment

restrict_robotsboolean

Whether to restrict robots for this environment

statusstring required

The status text of the response

codeinteger required

The status code of the response

No recorded changes to this operation across all 1 revision of this API.