{
  "opencollection": "1.0.0",
  "info": {
    "name": "Service Limits API",
    "version": "20181025"
  },
  "items": [
    {
      "info": {
        "name": "limits",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of resource limits for a service.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9090/20190729/limitDefinitions",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the parent compartment (remember that the tenancy is simply the root compartment).\n"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "query",
                "description": "The subscription OCID assigned to the tenant.\n"
              },
              {
                "name": "serviceName",
                "value": "",
                "type": "query",
                "description": "The target service name."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional field, filter for a specific resource limit."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'. By default, it is ascending.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n"
              }
            ]
          },
          "docs": "Includes a list of resource limits that are currently supported.\nIf the subscription ID is provided, then only resource limits supported by the subscription will be returned.\nIf the `areQuotasSupported` property is true, you can create quota policies on top of this limit at the compartment level.\n"
        },
        {
          "info": {
            "name": "Get the full list of resource limit values for the given service.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9090/20190729/limitValues",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the parent compartment (remember that the tenancy is simply the root compartment).\n"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "query",
                "description": "The subscription OCID assigned to the tenant.\n"
              },
              {
                "name": "externalLocation",
                "value": "",
                "type": "query",
                "description": "The external cloud provider location.\n"
              },
              {
                "name": "serviceName",
                "value": "",
                "type": "query",
                "description": "The target service name."
              },
              {
                "name": "scopeType",
                "value": "",
                "type": "query",
                "description": "Filter entries by scope type."
              },
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "Filter entries by availability domain. This implies that only AD-specific values are returned.\n"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Optional field, can be used to see a specific resource limit value."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. The sorting is by availabilityDomain, as a second level field, if available.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'. By default, it is ascending.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n"
              }
            ]
          },
          "docs": "Includes a full list of resource limits belonging to a given service.\nIf the subscription ID is provided, the limit value for the subscription will be returned.\n"
        },
        {
          "info": {
            "name": "Returns the list of supported services that have resource limits exposed.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9090/20190729/services",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the parent compartment (remember that the tenancy is simply the root compartment).\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'. By default, it is ascending.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "query",
                "description": "The subscription OCID assigned to the tenant.\n"
              }
            ]
          },
          "docs": "Returns the list of supported services. If subscription ID is provided then only services supported by subscription will be returned.\nThis includes the programmatic service name, along with the friendly service name.\n"
        },
        {
          "info": {
            "name": "Get the availability and usage within a compartment for a given resource limit.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9090/20190729/services/:serviceName/limits/:limitName/resourceAvailability",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "serviceName",
                "value": "",
                "type": "path",
                "description": "The service name of the target quota."
              },
              {
                "name": "limitName",
                "value": "",
                "type": "path",
                "description": "The limit name for which to fetch the data."
              },
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment for which data is being fetched."
              },
              {
                "name": "availabilityDomain",
                "value": "",
                "type": "query",
                "description": "This field is mandatory if the scopeType of the target resource limit is AD.\nOtherwise, this field should be omitted.\nIf the above requirements are not met, the API returns a 400 - InvalidParameter response.\n"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "query",
                "description": "The subscription OCID assigned to the tenant.\n"
              },
              {
                "name": "externalLocation",
                "value": "",
                "type": "query",
                "description": "The external cloud provider location.\n"
              }
            ]
          },
          "docs": "For a given compartmentId, resource limit name, and scope, returns the following:\n  * The number of available resources associated with the given limit.\n  * The usage in the selected compartment for the given limit.\nIf the subscription ID is provided, then usage for resource created in that subscription will be returned.\nNote that not all resource limits support this API. If the value is not available, the API returns a 404 response.\n"
        }
      ]
    }
  ],
  "bundled": true
}