Skip to content

Latest commit

 

History

History
61 lines (51 loc) · 3.18 KB

developerapp.md

File metadata and controls

61 lines (51 loc) · 3.18 KB

Developer application

A developer application holds the attribut.

Supported methods and paths

Method Path What
GET /v1/developers/developer/apps retrieve all apps of developer
POST /v1/developers/developer/apps creates a new developer app
GET /v1/developers/developer/apps/appname retrieve one developer app
POST /v1/developers/developer/apps/appname updates an existing developer app
DELETE /v1/developers/developer/apps/appname deletes a developer app
GET /v1/developers/developer/apps/appname/attributes retrieve all attributes of developer app
POST /v1/developers/developer/apps/appname/attributes update all attribute of developer app
GET /v1/developers/developer/apps/appname/attributes/name retrieve attribute of developer app
POST /v1/developers/developer/apps/appname/attributes/name update attribute of developer app
DELETE /v1/developers/developer/apps/appname/attributes/name deletes attribute of developer app
  • For POST content-type: application/json is required.

Example developer app definition

{
  "name": "teleporter",
  "displayName": "Teleportrrrrr",
  "status": "active",
  "attributes": [
    {
        "name": "people_quotaPerSecond",
        "value": "20"
    },
    {
      "name": "IPAccessList",
      "value": "10.0.0.0/8,192.168.178.0/24"
    },
    {
      "name": "Referer",
      "value": "example.org,*example.com"
    }
  ]
}

Fields specification

fieldname optional purpose
name mandatory name (cannot be updated afterwards)
displayName optional friendly name
status mandatory status, call will be rejected in case not set to "active"
attributes optional specific attributes

Attribute specification

attribute name purpose possible values
IPAccessList source ip request access list 10.0.0.0/8, 192.168.42.0/24
Referer HTTP Referer hostname access list *.example.com, www.example.net
productname _quotaPerSecond Set a specific quota per second rate for a particular product 50