Managed Service for Gitlab API, REST: Instance.Create

Field

Description

folderId

string

ID of the folder to create instance in.

name

string

Name of the instance (must be unique within the folder).

description

string

Description of the instance.

labels

object (map<string, string>)

Custom labels for the instance as key:value pairs. For example, "env": "prod".

resourcePresetId

string

ID of the resource preset for computational resources.

diskSize

string (int64)

Disk size in bytes.

adminLogin

string

Admin user login.

adminEmail

string

Admin user email.

domainPrefix

string

Domain prefix for the GitLab instance.

subnetId

string

ID of the subnet where instance will be created.

backupRetainPeriodDays

string (int64)

Number of days to retain backups.

maintenanceDeleteUntagged

boolean

Whether to delete untagged resources during maintenance.

deletionProtection

boolean

Whether deletion protection is enabled.

approvalRulesId

string

ID of approval rules for the instance.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateInstanceMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Instance

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

instanceId

string

ID of the GitLab instance being created.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

Unique instance ID.

folderId

string

Folder ID where instance resides.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Last update timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Human-readable name.

description

string

Instance description.

labels

object (map<string, string>)

Resource labels as key-value pairs.

resourcePresetId

string

Resource preset ID.

diskSize

string (int64)

Disk size in bytes.

status

enum (Status)

Current instance status.

• STATUS_UNSPECIFIED: Default state.
• CREATING: Instance is being created.
• RUNNING: Instance is running normally.
• UPDATING: Instance is being updated.
• ERROR: Instance is in error state.
• DELETING: Instance is being deleted.
• BACKUP_CREATING: Backup is being created.
• BACKUP_RESTORING: Backup is being restored.
• STARTING: Instance is starting.
• STOPPING: Instance is stopping.
• STOPPED: Instance is stopped.
• BACKGROUND_MIGRATIONS: Background migrations in progress.
• OBJECT_STORAGE_MIGRATIONS: Object storage migrations in progress.
• SNAPSHOT_RESTORING: Snapshot is being restored.

adminLogin

string

Admin username.

adminEmail

string

Admin email.

domain

string

Instance domain.

subnetId

string

Subnet ID.

plannedOperation

MaintenanceOperation

Planned maintenance operation.

backupRetainPeriodDays

string (int64)

How long to keep backups (days).

maintenanceDeleteUntagged

boolean

Delete untagged resources during maintenance.

deletionProtection

boolean

Protect from accidental deletion.

approvalRulesId

string

Approval rules ID.

gitlabVersion

string

GitLab version of the instance.

Field

Description

info

string

The description of the operation.

delayedUntil

string (date-time)

Delay time for the maintenance operation.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

latestMaintenanceTime

string (date-time)

Time of the last maintenance window.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

nextMaintenanceWindowTime

string (date-time)

Time of the next maintenance window.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).