Skip to content

Latest commit

 

History

History
276 lines (240 loc) · 3.92 KB

routes.md

File metadata and controls

276 lines (240 loc) · 3.92 KB
Raw

Routes

The following defines the interface for managing APIs and Tenants. These endpoints are exposed to port 9000.

APIs

PUT /v1/apis

Create a new API. Note that you should first create a tenant and obtain its tenantId. For API policy definitions, see here.

body:

{
  "name": *(string),
  "basePath": *(string),
  "tenantId": *(string),
  "resources": {
    "path": {
      "operations": {
        "get": {
          "backendMethod": *(string),
          "backendUrl": *(string),
          "policies": [
            {
              "type": *(string),
              "value": {}
            }
          ]
        },
        ...
      }
    }
  }
}

returns:

{
  "id": (string),
  "name": (string),
  "basePath": (string),
  "tenantId": (string),
  "resources": {
   ...
  }
}

PUT /v1/apis/{id}

Update attributes for a given API.

body:

{
  "name": *(string),
  "basePath": *(string),
  "tenantId": *(string),
  "resources": {
    "path": {
      "operations": {
        "get": {
          "backendMethod": *(string),
          "backendUrl": *(string),
          "policies": [
            {
              "type": *(string),
              "value": {}
            }
          ]
        },
        ...
      }
    }
  }
}

returns:

{
  "id": (string),
  "name": (string),
  "basePath": (string),
  "tenantId": (string),
  "resources": {
   ...
  }
}

GET /v1/apis

Find all instances of APIs added to the gateway.

returns:

[
  {
    "id": (string),
    "name": (string),
    "basePath": (string),
    "tenantId": (string),
    "resources": {
     ...
    }
  }
]

GET /v1/apis/{id}

Find an API by its id.

returns:

{
  "id": (string),
  "name": (string),
  "basePath": (string),
  "tenantId": (string),
  "resources": {
   ...
  }
}

GET /v1/apis/{id}/tenant

Find the tenant associated with this API.

returns:

{
 "id": (string),
 "namespace" (string),
 "instance" (string)
}

DELETE /v1/apis/{id}

Delete the API

returns:

{}

Tenants

PUT /v1/tenants

Create a new tenant.

body:

{
 "namespace": *(string),
 "instance": *(string)
}

returns:

{
 "id": (string),
 "namespace" (string),
 "instance" (string)
}

PUT /v1/tenants/{id}

Update attributes for a given tenant.

body:

{
 "namespace": *(string),
 "instance": *(string)
}

returns:

{
 "id": (string),
 "namespace" (string),
 "instance" (string)
}

GET /v1/tenants

Find all instances of tenants added to the gateway.

returns:

[
 {
  "id": (string),
  "namespace" (string),
  "instance" (string)
 }
]

GET /v1/tenants/{id}

Find a tenant by its id.

returns:

{
 "id": (string),
 "namespace" (string),
 "instance" (string)
}

DELETE /v1/tenants/{id}

Delete the tenant.

returns:

{}

GET /v1/tenants/{id}/apis

Get all APIs for the given tenant.

returns:

[
  {
    "id": (string),
    "name": (string),
    "basePath": (string),
    "tenantId": (string),
    "resources": {
     ...
    }
  }
]

Subscriptions

PUT /v1/subscriptions

Add/update an api key for the specified tenant, resource, or api.

body:

{
  "key": *(string) The api key to store to redis.
  "scope": *(string) The scope to use the api key. "tenant", "resource", or "api".
  "tenantId": *(string) Tenant guid.
  "resource": (string) Resource path. Required if scope is "resource".
  "apiId": (string) API Guid. Required if scope is "API".
}

Returns:

Subscription created.

DELETE /v1/subscriptions

Delete an api key associated with the specified tenant, resource or api.

body:

{
  "key": *(string) The api key to delete.
  "scope": *(string) The scope to use the api key. "tenant", "resource", or "api".
  "tenantId": *(string) Tenant guid.
  "resource": (string) Resource path. Required if scope is "resource".
  "apiId": (string) API Guid. Required if scope is "API".
}

Returns:

Subscription deleted.