Files
designate/doc/source/rest/v2/limits.rst
Endre Karlson 0f77f64a6d Add documentation for Limits
Closes-Bug: #1522518
Change-Id: I224528ec34728d301218f222566d4d6551522346
2015-12-14 16:20:10 +01:00

1.8 KiB

Limits

Overview

This endpoint is used to retrieve current limits.

Get Limits

Lists current limits

Example request:

GET /limits HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "max_page_limit": 1000,
  "max_recordset_name_length": 255,
  "max_recordset_records": 20,
  "max_zone_name_length": 255,
  "max_zone_records": 500,
  "max_zone_recordsets": 500,
  "max_zones": 10,
  "min_ttl": null
}
form max_page_limit

Max limit for paging

form max_recordset_name_length

Max length for a RecordSet name

form max_recordset_records

Max number RecordSet of Records

form max_zone_name_length

Max length for a Zone name

form max_zone_records

Max number of Records in a Zone

form max_zone_recordsets

Max number of RecordSets in a Zone

form max_zones

Max number of Zones

form max_ttl

Max TTL

statuscode 200

OK