{
  "opencollection": "1.0.0",
  "info": {
    "name": "Controlplane Api ApiChangelog Rover API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Rover",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Find all Rovers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "page size requested by the consumer; must not be larger than the maximal page size"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "cursor to be used for pagination. If not provided, the first page will be returned. The cursor is a string that points to a page of data."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "list of fields to be used for sorting. Default is name"
              }
            ]
          },
          "docs": "Find all Rovers of a Team"
        },
        {
          "info": {
            "name": "Create a Rover",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/rovers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Rover. Creating and updating resources is asynchronous, which is why the status is given as an answer to a POST/PUT request, since it is possible that the resource to be created has not yet been processed at the time the response is created. If the status after creation is in state \"Processing\", the resource must be queried with GET to see whether it was created successfully or whether errors/warnings are written in the status. If the creation/update is incorrect, the processing status "
        },
        {
          "info": {
            "name": "Read info of all applications of a Team",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers/info",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "page size requested by the consumer; must not be larger than the maximal page size"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "cursor to be used for pagination. If not provided, the first page will be returned. The cursor is a string that points to a page of data."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "list of fields to be used for sorting. Default is name"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "Filter by application names"
              },
              {
                "name": "shallowInfo",
                "value": "",
                "type": "query",
                "description": "If true, the status and information of all sub-resources will be omitted in the response. Only the information about the application itself will be returned. This will significantly reduce the response size and time. Default is false."
              }
            ]
          },
          "docs": "Read info of all applications of a Team"
        },
        {
          "info": {
            "name": "Find an existing Rover",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ]
          },
          "docs": "Find an existing Rover"
        },
        {
          "info": {
            "name": "Update an existing Rover",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Rover. Creating and updating resources is asynchronous, which is why the status is given as an answer to a POST/PUT request, since it is possible that the resource to be created has not yet been processed at the time the response is created. If the status after creation is in state \"Processing\", the resource must be queried with GET to see whether it was created successfully or whether errors/warnings are written in the status. If the creation/update is incorrect, the processi"
        },
        {
          "info": {
            "name": "Delete a Rover",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ]
          },
          "docs": "**Important:** The deletion is done asynchronously to ensure that the resource was actually deleted, use this or the GET resource until you receive a 404 response.  \nDelete Rover - will remove your API / Subscriptions / Exposures\n"
        },
        {
          "info": {
            "name": "Read info of a specific application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId/info",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              },
              {
                "name": "shallowInfo",
                "value": "",
                "type": "query",
                "description": "If true, the status and information of all sub-resources will be omitted in the response. Only the information about the application itself will be returned. This will significantly reduce the response size and time. Default is false."
              }
            ]
          },
          "docs": "Read info of a specific application"
        },
        {
          "info": {
            "name": "Rotate the clientSecret for an Application",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId/secret",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ]
          },
          "docs": "Initiates a secret rotation for the Application. The rotation is handled by the admission webhook which decides whether to perform a graceful rotation (old secret remains valid during a grace period) or a non-graceful rotation based on the zone configuration.\n"
        },
        {
          "info": {
            "name": "Get the secret rotation status for an Application",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId/secret/status",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ]
          },
          "docs": "Returns the current secret rotation status for an Application, including whether a graceful rotation is in progress, whether it has converged, and the relevant expiry timestamps.\n"
        },
        {
          "info": {
            "name": "Find an existing Rover and return its status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/rovers/:roverId/status",
            "params": [
              {
                "name": "roverId",
                "value": "",
                "type": "path",
                "description": "The unique id of this resource following the pattern group--team--resourceName"
              }
            ]
          },
          "docs": "Find an existing Rover and return its status"
        }
      ]
    }
  ],
  "bundled": true
}