Namespace HTTP API

The /namespace endpoints are used to query for and interact with namespaces.

List Namespaces

This endpoint lists all namespaces.

Method	Path	Produces
`GET`	`/v1/namespaces`	`application/json`

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries	ACL Required
`YES`	`namespace:*` Any capability on the namespace authorizes the endpoint

Parameters

prefix (string: "")- Specifies a string to filter namespaces on based on an index prefix. This is specified as a query string parameter.

Sample Request

$ curl \
    https://localhost:4646/v1/namespaces

$ curl \
    https://localhost:4646/v1/namespaces?prefix=prod

Sample Response

[
  {
    "Capabilities": null,
    "CreateIndex": 1,
    "Description": "Default shared namespace",
    "Meta": null,
    "ModifyIndex": 1,
    "Name": "default",
    "Quota": ""
  },
  {
    "Capabilities": null,
    "CreateIndex": 17,
    "Description": "Development Staging Namespace",
    "Meta": {
        "type": "dev",
        "contact": "helpdesk@example.com"
    },
    "ModifyIndex": 17,
    "Name": "staging",
    "Quota": ""
  }
]

Read Namespace

This endpoint reads information about a specific namespace.

Method	Path	Produces
`GET`	`/v1/namespace/:namespace`	`application/json`

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries	ACL Required
`YES`	`namespace:*` Any capability on the namespace authorizes the endpoint

Parameters

:namespace (string: <required>)- Specifies the namespace to query.

Sample Request

$ curl \
    https://localhost:4646/v1/namespace/staging

Sample Response

{
  "Capabilities": null,
  "CreateIndex": 17,
  "Description": "Development Staging Namespace",
  "Meta": {
    "type": "dev",
    "contact": "helpdesk@example.com"
  },
  "ModifyIndex": 17,
  "Name": "staging",
  "Quota": ""
}

Create or Update Namespace

This endpoint is used to create or update a namespace.

Method	Path	Produces
`POST`	`/v1/namespace/:namespace` `/v1/namespace`	`application/json`

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries	ACL Required
`NO`	`management`

Parameters

Name (string: <required>)- Specifies the namespace to create or update.
Description (string: "") - Specifies an optional human-readable description of the namespace.
Meta (object: null) - Optional object with string keys and values of metadata to attach to the namespace. Namespace metadata is not used by Nomad and is intended for use by operators and third party tools.
Quota (string: "") Enterprise - Specifies an quota to attach to the namespace.
Capabilities (Capabilities: <optional>) - Specifies capabilities allowed in the namespace. These values are checked at job submission.
- EnabledTaskDrivers (array<string>: []) - List of task drivers allowed in the namespace. If empty all task drivers are allowed.
- DisabledTaskDrivers (array<string>: []) - List of task drivers disabled in the namespace.
NodePoolConfiguration (NodePoolConfiguration: <optional>) Enterprise - Specifies node pool configurations. These values are checked at job submission.
- Default (string: "default") - Specifies the node pool to use for jobs in this namespace that don't define a node pool in their specification.
- Allowed (array<string>: []) - Specifies the node pools that are allowed to be used by jobs in this namespace. This field supports wildcard globbing through the use of * for multi-character matching. If specified, only the node pools that match these patterns are allowed. This field cannot be used with Disabled.
- disabled (array<string>: []) - Specifies the node pools that are not allowed to be used by jobs in this namespace. This field supports wildcard globbing through the use of * for multi-character matching. If specified, any node pool is allowed except for those that match any of these patterns. This field cannot be used with Enabled.

Sample Payload

{
  "Name": "api-prod",
  "Description": "Production API Servers",
  "Meta": {
    "contact": "platform-eng@example.com"
  },
  "Quota": "prod-quota",
  "Capabilities": {
    "DisabledTaskDrivers": ["raw_exec"]
  },
  "NodePoolConfiguration": {
    "Default": "prod-pool",
    "Allowed": ["default"]
  }
}

Sample Request

$ curl \
    --request POST \
    --data @namespace.json \
    https://localhost:4646/v1/namespace/api-prod

$ curl \
    --request POST \
    --data @namespace.json \
    https://localhost:4646/v1/namespace

Delete Namespace

This endpoint is used to delete a namespace.

Method	Path	Produces
`DELETE`	`/v1/namespace/:namespace`	`application/json`

The table below shows this endpoint's support for blocking queries and required ACLs.

Blocking Queries	ACL Required
`NO`	`management`

Parameters

:namespace (string: <required>)- Specifies the namespace to delete.

Sample Request

$ curl \
    --request DELETE \
    https://localhost:4646/v1/namespace/api-prod