Get a change request for a branch
Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses
read_branch, delete_branch, create_branch, connect_production_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_branches |
| Database | read_branches |
| Branch | read_branch |
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Organization name slug from list_organizations. Example: acme.
Database name slug from list_databases. Example: app-db.
Branch name from list_branches. Example: main.
The ID of the change request
Response
Returns a Neki change request
The type of change request
NekiAdminChangeRequest, NekiClusterChangeRequest, NekiConfigurationProfileChangeRequest, NekiRouterChangeRequest, NekiSidecarChangeRequest The ID of the change request
The state of the change request
draft, pending, applying, canceled, completed Whether the change request can be deleted
The time the change request started
The time the change request completed
The time the change request was created
The time the change request was last updated
The ID of the resource being changed
The type of resource being changed
NekiAdmin, NekiCluster, NekiConfigurationProfile, NekiRouter, NekiSidecar The name of the resource being changed
The name of the admin size SKU
The display name of the admin size SKU
The parameters requested for the target resource
The previous name of the admin size SKU
The previous display name of the admin size SKU
The target resource parameters before the change
The cluster flags
The Neki image version
The previous cluster flags
The previous Neki image version
The name of the router size SKU
The display name of the router size SKU
The number of replicas in each cell
Whether the router scales horizontally within each cell
The maximum number of replicas in each cell when autoscaling
The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70
The previous name of the router size SKU
The previous display name of the router size SKU
The previous number of replicas in each cell
The previous autoscaling state of the router
The previous maximum number of replicas in each cell
The previous target average CPU utilization percentage
The name of the shard configuration profile
The previous name of the shard configuration profile
The name of the cluster size SKU
The display name of the cluster size SKU
Whether the cluster size SKU uses metal instances
The display order of the cluster size SKU
The number of replicas
The number of shards
The PostgreSQL image
The previous name of the cluster size SKU
The previous display name of the cluster size SKU
Whether the previous cluster size SKU used metal instances
The previous display order of the cluster size SKU
The previous number of replicas
The previous number of shards
The previous PostgreSQL image

