# Create an Endpoint

Launch stage: GA

`POST /api/2.0/postgres/{parent=projects/*/branches/*}/endpoints`

Creates a new compute endpoint in the branch.

API scopes: postgres

## Path parameters

- `parent` (string, required)
  The Branch where this Endpoint will be created.
   Format: projects/{project_id}/branches/{branch_id}

## Query parameters

- `endpoint_id` (string, required)
  The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
   The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
   For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.
- `replace_existing` (boolean, optional, Input only)
  If true, update the endpoint if it already exists instead of returning an error.

## Request body

The Endpoint to create.
- `name` (string, optional, ID, Immutable)
  Output only. The full resource path of the endpoint.
   Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- `spec` (object, optional, Input only)
  The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.
  - `endpoint_type` (string, required, Immutable)
    The endpoint type. A branch can only have one READ_WRITE endpoint.
    Possible values:
    - `ENDPOINT_TYPE_UNSPECIFIED`
    - `ENDPOINT_TYPE_READ_WRITE`
    - `ENDPOINT_TYPE_READ_ONLY`
  - `autoscaling_limit_min_cu` (double, optional)
    The minimum number of Compute Units. Minimum value is 0.5.
  - `autoscaling_limit_max_cu` (double, optional)
    The maximum number of Compute Units. The maximum value is 64.
     The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
  - `disabled` (boolean, optional)
    Whether to restrict connections to the compute endpoint.
     Enabling this option schedules a suspend compute operation.
     A disabled compute endpoint cannot be enabled by a connection or
     console action.
  - `suspend_timeout_duration` (string, optional)
    Duration of inactivity after which the compute endpoint is automatically suspended.
     If specified should be between 60s and 604800s (1 minute to 1 week).
     Mutually exclusive with `no_suspension`.
  - `no_suspension` (boolean, optional)
    When set to true, explicitly disables automatic suspension (never suspend).
     Should be set to true when provided.
     Mutually exclusive with `suspend_timeout_duration`.
  - `settings` (object, optional)
    - `pg_settings` (object, optional)
      A raw representation of Postgres settings.
  - `group` (object, optional)
    Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults
     to non HA settings, with a single compute backing the endpoint (and no readable secondaries
     for Read/Write endpoints).
    - `min` (int32, required)
      The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
       than or equal to 1.
    - `max` (int32, required)
      The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
       compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
       true on the EndpointSpec.
    - `enable_readable_secondaries` (boolean, optional)
      Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
       size.max > 1.

## Returns

- `name` (string, optional)
  The server-assigned name, which is only unique within the same service that
   originally returns it. If you use the default HTTP mapping, the
   `name` should be a resource name ending with `operations/{unique_id}`.
- `metadata` (object, optional)
  Service-specific metadata associated with the operation.  It typically
   contains progress information and common metadata such as create time.
   Some services might not provide such metadata.
- `done` (boolean, optional)
  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.
- `error` (object, optional)
  The error result of the operation in case of failure or cancellation.
  - `error_code` (string, optional)
    Possible values:
    - `UNKNOWN`
    - `INTERNAL_ERROR`
    - `TEMPORARILY_UNAVAILABLE`
    - `IO_ERROR`
    - `BAD_REQUEST`
    - `SERVICE_UNDER_MAINTENANCE`
    - `WORKSPACE_TEMPORARILY_UNAVAILABLE`
    - `DEADLINE_EXCEEDED`
    - `CANCELLED`
    - `RESOURCE_EXHAUSTED`
    - `ABORTED`
    - `NOT_FOUND`
    - `ALREADY_EXISTS`
    - `UNAUTHENTICATED`
    - `UNAVAILABLE`
    - `INVALID_PARAMETER_VALUE`
    - `ENDPOINT_NOT_FOUND`
    - `MALFORMED_REQUEST`
    - `INVALID_STATE`
    - `PERMISSION_DENIED`
    - `FEATURE_DISABLED`
    - `CUSTOMER_UNAUTHORIZED`
    - `REQUEST_LIMIT_EXCEEDED`
    - `RESOURCE_CONFLICT`
    - `UNPARSEABLE_HTTP_ERROR`
    - `NOT_IMPLEMENTED`
    - `DATA_LOSS`
    - `INVALID_STATE_TRANSITION`
    - `COULD_NOT_ACQUIRE_LOCK`
    - `RESOURCE_ALREADY_EXISTS`
    - `RESOURCE_DOES_NOT_EXIST`
    - `QUOTA_EXCEEDED`
    - `MAX_BLOCK_SIZE_EXCEEDED`
    - `MAX_READ_SIZE_EXCEEDED`
    - `PARTIAL_DELETE`
    - `MAX_LIST_SIZE_EXCEEDED`
    - `DRY_RUN_FAILED`
    - `RESOURCE_LIMIT_EXCEEDED`
    - `DIRECTORY_NOT_EMPTY`
    - `DIRECTORY_PROTECTED`
    - `MAX_NOTEBOOK_SIZE_EXCEEDED`
    - `MAX_CHILD_NODE_SIZE_EXCEEDED`
    - `SEARCH_QUERY_TOO_LONG`
    - `SEARCH_QUERY_TOO_SHORT`
    - `MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST`
    - `PERMISSION_NOT_PROPAGATED`
    - `DEPLOYMENT_TIMEOUT`
    - `GIT_CONFLICT`
    - `GIT_UNKNOWN_REF`
    - `GIT_SENSITIVE_TOKEN_DETECTED`
    - `GIT_URL_NOT_ON_ALLOW_LIST`
    - `GIT_REMOTE_ERROR`
    - `PROJECTS_OPERATION_TIMEOUT`
    - `IPYNB_FILE_IN_REPO`
    - `INSECURE_PARTNER_RESPONSE`
    - `MALFORMED_PARTNER_RESPONSE`
    - `METASTORE_DOES_NOT_EXIST`
    - `DAC_DOES_NOT_EXIST`
    - `CATALOG_DOES_NOT_EXIST`
    - `SCHEMA_DOES_NOT_EXIST`
    - `TABLE_DOES_NOT_EXIST`
    - `SHARE_DOES_NOT_EXIST`
    - `RECIPIENT_DOES_NOT_EXIST`
    - `STORAGE_CREDENTIAL_DOES_NOT_EXIST`
    - `EXTERNAL_LOCATION_DOES_NOT_EXIST`
    - `PRINCIPAL_DOES_NOT_EXIST`
    - `PROVIDER_DOES_NOT_EXIST`
    - `METASTORE_ALREADY_EXISTS`
    - `DAC_ALREADY_EXISTS`
    - `CATALOG_ALREADY_EXISTS`
    - `SCHEMA_ALREADY_EXISTS`
    - `TABLE_ALREADY_EXISTS`
    - `SHARE_ALREADY_EXISTS`
    - `RECIPIENT_ALREADY_EXISTS`
    - `STORAGE_CREDENTIAL_ALREADY_EXISTS`
    - `EXTERNAL_LOCATION_ALREADY_EXISTS`
    - `PROVIDER_ALREADY_EXISTS`
    - `CATALOG_NOT_EMPTY`
    - `SCHEMA_NOT_EMPTY`
    - `METASTORE_NOT_EMPTY`
    - `PROVIDER_SHARE_NOT_ACCESSIBLE`
  - `message` (string, optional)
  - `stack_trace` (string, optional)
  - `details` (array of object, optional)
- `response` (object, optional)
  The normal, successful response of the operation.

## Response

```json
{
  "name": "string",
  "metadata": {},
  "done": true,
  "error": {
    "error_code": "UNKNOWN",
    "message": "string",
    "stack_trace": "string",
    "details": [
      {}
    ]
  },
  "response": {}
}
```