Own Docker? Customize your docs with AI search, analytics, and more.

Claim your docs

Docker

POST

Create a network

/v1.33/networks/create

Access Token Required: API Key

Body Params

IPAMstring

Namestringrequired

The network's name.

Driverstring

Name of the network driver plugin to use.

Labelsobject

User-defined key/value metadata.

Ingressboolean

Ingress network is the network which provides the routing-mesh in swarm mode.

Optionsobject

Network specific options to be used by the drivers.

Internalboolean

Restrict external access to the network.

Attachableboolean

Globally scoped network is manually attachable by regular containers from workers in swarm mode.

EnableIPv6boolean

Enable IPv6 on the network.

CheckDuplicateboolean

Check for networks with duplicate names. Since Network is primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. CheckDuplicate is there to provide a best effort checking of any networks which has the same name but it is not guaranteed to catch all name collisions.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/networks/create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}