Network Provider

Network Provider create

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

name*string

Match^[a-zA-Z0-9_-]+$

Length1 <= length <= 64

config*||||

peers?

Default[]

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/networkProvider.create" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "config": {
      "providerType": "docker"
    }
  }'

curl -X POST "https://your-notploy-instance.com/api/networkProvider.create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "config": {      "providerType": "docker"    }  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider update

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

networkProviderId*string

Length1 <= length

name*string

Match^[a-zA-Z0-9_-]+$

Length1 <= length <= 64

config*||||

peers?

Default[]

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/networkProvider.update" \
  -H "Content-Type: application/json" \
  -d '{
    "networkProviderId": "string",
    "name": "string",
    "config": {
      "providerType": "docker"
    }
  }'

curl -X POST "https://your-notploy-instance.com/api/networkProvider.update" \  -H "Content-Type: application/json" \  -d '{    "networkProviderId": "string",    "name": "string",    "config": {      "providerType": "docker"    }  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider remove

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

networkProviderId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/networkProvider.remove" \
  -H "Content-Type: application/json" \
  -d '{
    "networkProviderId": "string"
  }'

curl -X POST "https://your-notploy-instance.com/api/networkProvider.remove" \  -H "Content-Type: application/json" \  -d '{    "networkProviderId": "string"  }'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider all

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/networkProvider.all"

curl -X GET "https://your-notploy-instance.com/api/networkProvider.all"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider one

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

networkProviderId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/networkProvider.one?networkProviderId=string"

curl -X GET "https://your-notploy-instance.com/api/networkProvider.one?networkProviderId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider peers

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

networkProviderId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/networkProvider.peers?networkProviderId=string"

curl -X GET "https://your-notploy-instance.com/api/networkProvider.peers?networkProviderId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider test Connection

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Request Body

application/json

networkProviderId?string

Length1 <= length

config?||||

peers?

Response Body

`application/json`

curl -X POST "https://your-notploy-instance.com/api/networkProvider.testConnection" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://your-notploy-instance.com/api/networkProvider.testConnection" \  -H "Content-Type: application/json" \  -d '{}'

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider descriptors

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/networkProvider.descriptors"

curl -X GET "https://your-notploy-instance.com/api/networkProvider.descriptors"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Network Provider health

Authorization

apiKey

x-api-key<token>

API key authentication. Generate an API key from your Notploy dashboard under Settings > API Keys.

In: header

Query Parameters

networkProviderId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://your-notploy-instance.com/api/networkProvider.health?networkProviderId=string"

curl -X GET "https://your-notploy-instance.com/api/networkProvider.health?networkProviderId=string"

{}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`