{
  "opencollection": "1.0.0",
  "info": {
    "name": "PlanetScale Platform Backups Branches API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Branches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List branches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page."
              }
            ]
          },
          "docs": "Returns a list of all branches for a specific database."
        },
        {
          "info": {
            "name": "Create a branch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new branch for the specified database. Branches are isolated copies of the database schema used for development and testing."
        },
        {
          "info": {
            "name": "Get a branch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              },
              {
                "name": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch."
              }
            ]
          },
          "docs": "Returns details about a specific branch, including its schema status, cluster configuration, and readiness state."
        },
        {
          "info": {
            "name": "Update a branch",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              },
              {
                "name": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates properties of a specific branch, such as its cluster configuration."
        },
        {
          "info": {
            "name": "Delete a branch",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              },
              {
                "name": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch."
              }
            ]
          },
          "docs": "Deletes a database branch. Production branches cannot be deleted."
        },
        {
          "info": {
            "name": "Lint a branch schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.planetscale.com/v1/organizations/:organization/databases/:database/branches/:branch/schema-lint",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The name of the organization."
              },
              {
                "name": "database",
                "value": "",
                "type": "path",
                "description": "The name of the database."
              },
              {
                "name": "branch",
                "value": "",
                "type": "path",
                "description": "The name of the branch."
              }
            ]
          },
          "docs": "Returns schema lint results for the specified branch, identifying potential issues and recommendations."
        }
      ]
    }
  ],
  "bundled": true
}