{
  "opencollection": "1.0.0",
  "info": {
    "name": "Xata API Keys Branches API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Branches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all branches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project to list branches from"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieves a list of all branches within the specified project, including their metadata, region, and access settings."
        },
        {
          "info": {
            "name": "Create a new branch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project to create the branch in"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Creates a new branch within the specified project. Branches can be created from scratch or derived from an existing parent branch."
        },
        {
          "info": {
            "name": "Get branch details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project containing the branch"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the branch to retrieve details for"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieves detailed information about a specific branch by its ID, including status, connection string, and configuration."
        },
        {
          "info": {
            "name": "Update branch details",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project containing the branch"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the branch to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Updates the configuration of a specific branch by its ID, such as changing its name, description, or resource allocation."
        },
        {
          "info": {
            "name": "Delete a branch",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project containing the branch"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the branch to delete"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Permanently deletes a specific branch by its ID and all associated data. This action cannot be undone."
        },
        {
          "info": {
            "name": "Retrieve branch credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/credentials",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path"
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "Username that the credentials requested for"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieve branch credentials"
        },
        {
          "info": {
            "name": "Rotate branch credentials",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/credentials/rotate",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Triggers a credential rotation for the branch database user. The new credentials can be retrieved via the credentials endpoint after rotation completes."
        },
        {
          "info": {
            "name": "Retrieve branch metrics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/metrics",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Returns time-series data for one or more metrics of a branch."
        },
        {
          "info": {
            "name": "Create a new branch from a backup of another branch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/restore",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project containing the source branch"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the source branch of the backup"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Creates a new backup branch within the specified project."
        },
        {
          "info": {
            "name": "Retrieve branch logs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/logs",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieve branch logs"
        },
        {
          "info": {
            "name": "Get PostgreSQL configuration details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.xata.tech/organizations/:organizationID/projects/:projectID/branches/:branchID/postgres-config",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the organization containing the project"
              },
              {
                "name": "projectID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the project containing the branch"
              },
              {
                "name": "branchID",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the branch to retrieve PostgreSQL configuration for"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://auth.xata.io/realms/xata/protocol/openid-connect/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Retrieves detailed information about the current PostgreSQL configuration parameters for a branch, including parameter types, descriptions, acceptable ranges, default values, and current values."
        }
      ]
    }
  ],
  "bundled": true
}