Neon.Postgres (preview:2025-06-23)

2025/09/10 • 1 updated methods

Organizations_Update (updated)
Description :  Update a OrganizationResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "Organizations_Update",
  "$parameters": {
    "properties": {
      "Description": {
        "new": "The type used for update operations of the OrganizationResource.",
        "old": "Organization Resource by Neon"
      },
      "$properties": {
        "@added_ad0ffa2fc62146da8ca03833738ef512": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: False ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: False ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: False ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: False ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: False ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: False ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
roleName:
{
Description: Name of the role ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the role was last updated ,
Required: False ,
}
string ,
owns:
{
Description: Databases name associated with the role ,
Required: False ,
}
string ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the database was last updated ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
endpointId:
{
Description: Unique identifier for the compute endpoint ,
Required: False ,
}
string ,
computeName:
{
Description: Name of the compute endpoint ,
Required: False ,
}
string ,
status:
{
Description: The current status of the compute endpoint ,
Enum:
{
init: The compute endpoint is currently initializing ,
active: The compute endpoint is currently active ,
idle: The compute endpoint is currently idle ,
}
,
Required: False ,
}
enum ,
lastActive:
{
Description: The timestamp when the compute endpoint was last active ,
Required: False ,
}
string ,
size:
{
Description: The compute units size range for autoscaling (MinCU-MaxCU) ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: The minimum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: The maximum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
branchId:
{
Description: Unique identifier for the branch ,
Required: False ,
}
string ,
branch:
{
Description: Name of the branch ,
Required: False ,
}
string ,
dataSize:
{
Description: Total data size in MB for the branch ,
Required: False ,
}
string ,
lastActive:
{
Description: Last active compute for the branch ,
Required: False ,
}
string ,
computeHours:
{
Description: Compute hours for the branch ,
Required: False ,
}
string ,
protected:
{
Description: Branch protected status ,
Required: False ,
}
boolean ,
isDefault:
{
Description: Branch default status ,
Required: False ,
}
boolean ,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
roleName:
{
Description: Name of the role ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the role was last updated ,
Required: False ,
}
string ,
owns:
{
Description: Databases name associated with the role ,
Required: False ,
}
string ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the database was last updated ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
endpointId:
{
Description: Unique identifier for the compute endpoint ,
Required: False ,
}
string ,
computeName:
{
Description: Name of the compute endpoint ,
Required: False ,
}
string ,
status:
{
Description: The current status of the compute endpoint ,
Enum:
{
init: The compute endpoint is currently initializing ,
active: The compute endpoint is currently active ,
idle: The compute endpoint is currently idle ,
}
,
Required: False ,
}
enum ,
lastActive:
{
Description: The timestamp when the compute endpoint was last active ,
Required: False ,
}
string ,
size:
{
Description: The compute units size range for autoscaling (MinCU-MaxCU) ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: The minimum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: The maximum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
roleName:
{
Description: Name of the role ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the role was last updated ,
Required: False ,
}
string ,
owns:
{
Description: Databases name associated with the role ,
Required: False ,
}
string ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the database was last updated ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
endpointId:
{
Description: Unique identifier for the compute endpoint ,
Required: False ,
}
string ,
computeName:
{
Description: Name of the compute endpoint ,
Required: False ,
}
string ,
status:
{
Description: The current status of the compute endpoint ,
Enum:
{
init: The compute endpoint is currently initializing ,
active: The compute endpoint is currently active ,
idle: The compute endpoint is currently idle ,
}
,
Required: False ,
}
enum ,
lastActive:
{
Description: The timestamp when the compute endpoint was last active ,
Required: False ,
}
string ,
size:
{
Description: The compute units size range for autoscaling (MinCU-MaxCU) ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: The minimum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: The maximum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
branchId:
{
Description: Unique identifier for the branch ,
Required: False ,
}
string ,
branch:
{
Description: Name of the branch ,
Required: False ,
}
string ,
dataSize:
{
Description: Total data size in MB for the branch ,
Required: False ,
}
string ,
lastActive:
{
Description: Last active compute for the branch ,
Required: False ,
}
string ,
computeHours:
{
Description: Compute hours for the branch ,
Required: False ,
}
string ,
protected:
{
Description: Branch protected status ,
Required: False ,
}
boolean ,
isDefault:
{
Description: Branch default status ,
Required: False ,
}
boolean ,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
roleName:
{
Description: Name of the role ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the role was last updated ,
Required: False ,
}
string ,
owns:
{
Description: Databases name associated with the role ,
Required: False ,
}
string ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
databaseName:
{
Description: Name of the database ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Timestamp indicating when the database was last updated ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
endpointId:
{
Description: Unique identifier for the compute endpoint ,
Required: False ,
}
string ,
computeName:
{
Description: Name of the compute endpoint ,
Required: False ,
}
string ,
status:
{
Description: The current status of the compute endpoint ,
Enum:
{
init: The compute endpoint is currently initializing ,
active: The compute endpoint is currently active ,
idle: The compute endpoint is currently idle ,
}
,
Required: False ,
}
enum ,
lastActive:
{
Description: The timestamp when the compute endpoint was last active ,
Required: False ,
}
string ,
size:
{
Description: The compute units size range for autoscaling (MinCU-MaxCU) ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: The minimum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: The maximum compute units for autoscaling ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}