Delete role | Neon Docs

DELETE/projects/{project_id}/branches/{branch_id}/roles/{role_name}Delete role

Deletes the specified Postgres role from the branch. For related information, see Manage roles.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The branch ID

pattern ^[a-z0-9-]{1,60}$

role_namestringpathrequired

The role name

Responses

valueRoleOperations

allOf · 2 options

Option 1objectRoleResponse

roleobjectrequired

Show child attributes

authentication_methodstring

Authentication method configured for this role: `password`, `oauth`, or `no_login`.

branch_idstringrequired

The ID of the branch this role belongs to.

pattern ^[a-z0-9-]{1,60}$

created_atstring · date-timerequired

A timestamp indicating when the role was created

namestringrequired

Postgres role name within the branch.

passwordstring

The role password

protectedboolean

Whether or not the role is system-protected

updated_atstring · date-timerequired

A timestamp indicating when the role was last updated

Option 2objectOperationsResponse

operationsarray of objectrequired

Show child attributes

Show array items

An asynchronous action Neon performs on your resources (for example, starting a compute or creating a branch). Fields such as `action`, `status`, and `total_duration_ms` describe the operation and its progress.

actionstringrequired

The action performed by the operation

one of "create_compute", "create_timeline", "start_compute", "suspend_compute", "apply_config", "check_availability", "delete_timeline", "create_branch", "import_data", "tenant_ignore", "tenant_attach", "tenant_detach", "tenant_detach_safekeepers", "tenant_attach_safekeepers", "tenant_reattach", "replace_safekeeper", "disable_maintenance", "apply_storage_config", "prepare_secondary_pageserver", "switch_pageserver", "detach_parent_branch", "timeline_archive", "timeline_unarchive", "start_reserved_compute", "sync_dbs_and_roles_from_compute", "apply_schema_from_branch", "timeline_mark_invisible", "timeline_update_protected_config", "prewarm_replica", "promote_replica", "set_storage_non_dirty", "swap_binding_id", "finalize_migration", "mark_migration_prepared", "update_catalog", "epc_sync"

branch_idstring

The ID of the branch this operation ran on.

pattern ^[a-z0-9-]{1,60}$

created_atstring · date-timerequired

A timestamp indicating when the operation was created

endpoint_idstring

The ID of the compute endpoint this operation ran on.

pattern ^[a-z0-9-]{1,60}$

errorstring

Human-readable message describing why the operation failed.

failures_countinteger · int32required

The number of times the operation failed

idstring · uuidrequired

The operation ID

project_idstringrequired

The ID of the project this operation ran on.

pattern ^[a-z0-9-]{1,60}$

retry_atstring · date-time

A timestamp indicating when the operation was last retried

statusstringrequired

Lifecycle state of the operation. `scheduling`: queued, not yet started. `running`: actively executing. `finished`: completed successfully. `failed`: ended with a failure. `error`: ended with a terminal error. `cancelling`: cancellation requested but not yet complete. `cancelled`: stopped before completion. `skipped`: bypassed without executing.

one of "scheduling", "running", "finished", "failed", "error", "cancelling", "cancelled", "skipped"

total_duration_msinteger · int32required

The total duration of the operation in milliseconds

updated_atstring · date-timerequired

A timestamp indicating when the operation status was last updated

Example response

{
  "operations": [
    {
      "action": "apply_config",
      "branch_id": "br-raspy-hill-832856",
      "created_at": "2022-12-01T19:48:11Z",
      "endpoint_id": "ep-steep-bush-777093",
      "failures_count": 0,
      "id": "db646be3-eace-4910-9f60-8150823c5cb8",
      "project_id": "shiny-wind-028834",
      "status": "running",
      "total_duration_ms": 100,
      "updated_at": "2022-12-01T19:48:11Z"
    },
    {
      "action": "suspend_compute",
      "branch_id": "br-raspy-hill-832856",
      "created_at": "2022-12-01T19:48:11Z",
      "endpoint_id": "ep-steep-bush-777093",
      "failures_count": 0,
      "id": "ab94cdad-7630-4943-a55e-5a0952d2e598",
      "project_id": "shiny-wind-028834",
      "status": "scheduling",
      "total_duration_ms": 100,
      "updated_at": "2022-12-01T19:48:11Z"
    }
  ],
  "role": {
    "branch_id": "br-raspy-hill-832856",
    "created_at": "2022-12-01T14:36:23Z",
    "name": "thomas",
    "protected": false,
    "updated_at": "2022-12-01T14:36:23Z"
  }
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

role_namerequiredpath parameter

curl -X DELETE 'https://console.neon.tech/api/v2/projects/string/branches/string/roles/string'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/roles/string', { method: 'DELETE' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/roles/string', { method: 'DELETE' });
console.log(await response.json());

import requests

response = requests.request("DELETE", "https://console.neon.tech/api/v2/projects/string/branches/string/roles/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "DELETE", "https://console.neon.tech/api/v2/projects/string/branches/string/roles/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/roles/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/roles/string"))
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/roles/string")
request = Net::HTTPGenericRequest.new("DELETE", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Delete, "https://console.neon.tech/api/v2/projects/string/branches/string/roles/string");
using var response = await client.SendAsync(request);

{
  "operations": [
    {
      "action": "apply_config",
      "branch_id": "br-raspy-hill-832856",
      "created_at": "2022-12-01T19:48:11Z",
      "endpoint_id": "ep-steep-bush-777093",
      "failures_count": 0,
      "id": "db646be3-eace-4910-9f60-8150823c5cb8",
      "project_id": "shiny-wind-028834",
      "status": "running",
      "total_duration_ms": 100,
      "updated_at": "2022-12-01T19:48:11Z"
    },
    {
      "action": "suspend_compute",
      "branch_id": "br-raspy-hill-832856",
      "created_at": "2022-12-01T19:48:11Z",
      "endpoint_id": "ep-steep-bush-777093",
      "failures_count": 0,
      "id": "ab94cdad-7630-4943-a55e-5a0952d2e598",
      "project_id": "shiny-wind-028834",
      "status": "scheduling",
      "total_duration_ms": 100,
      "updated_at": "2022-12-01T19:48:11Z"
    }
  ],
  "role": {
    "branch_id": "br-raspy-hill-832856",
    "created_at": "2022-12-01T14:36:23Z",
    "name": "thomas",
    "protected": false,
    "updated_at": "2022-12-01T14:36:23Z"
  }
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}