Admin API reference

INTRODUCTION

Nimble’s Admin API allows you to perform a number of key account functions, including:

• Create, list, update, and delete pipelines

• View account status and remaining credits

• View account-level and pipeline-level usage reports

• Manage authenticated IPs

Authentication

Get authentication token

This API uses JWT/Bearer authentication:

To generate a token, make a request with the following body/payload: { "username": "string", "password": "string" }

Apply the received token in your following API request, by adding the header: authorization: Bearer [token]

auth.Token TTL time is 72 HRs.

POSThttps://api.nimbleway.com/api/v1/account/login

Body

application/json

User credentials

username*string

password*string

Response

200400401

OK

Body

application/json

tokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "password": "text",
      "username": "text"
    }),
});
const data = await response.json();

Response

200400401

{
  "token": "text"
}

Get new authentication token

This API uses basic authentication: To generate a token, make a request without a body while authorized with your old token auth.Token TTL time is 72 HRs.

POSThttps://api.nimbleway.com/api/v1/account/login/refresh

Authorization

bearerAuth

Response

200401

OK

Body

application/json

tokenstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/login/refresh', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "token": "text"
}

Authenticated IPs

List account rules

Authenticated IPs allow the use of Nimble pipelines without username or password in your proxy settings

GEThttps://api.nimbleway.com/api/v1/account/authenticatedips

Authorization

bearerAuth

Response

200401

OK

Body

application/json

authorized_ipsarray of string

idstring

pipeline_rulesarray of whitelist.PipelineRules (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/authenticatedips', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "authorized_ips": [
    "text"
  ],
  "id": "text",
  "pipeline_rules": [
    {
      "pipeline_name": "text",
      "port_range_end": 0,
      "port_range_start": 0
    }
  ]
}

Create a rule

An authenticated IP can only be used with a single account. Authenticated IP will identify the target account in your proxy requests, replacing the need for using username or password

PUThttps://api.nimbleway.com/api/v1/account/authenticatedips

Authorization

bearerAuth

Body

application/json

Authenticated IP Rule

ip_addresses*array of string

Response

200401

OK

Body

application/json

authorized_ipsarray of string

idstring

pipeline_rulesarray of whitelist.PipelineRules (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/authenticatedips', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ip_addresses": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200401

{
  "authorized_ips": [
    "text"
  ],
  "id": "text",
  "pipeline_rules": [
    {
      "pipeline_name": "text",
      "port_range_end": 0,
      "port_range_start": 0
    }
  ]
}

Delete a rule

Delete an authenticated IP rule

DELETEhttps://api.nimbleway.com/api/v1/account/authenticatedips

Authorization

bearerAuth

Body

application/json

Authenticated IP Rule

ip_address*string

Response

200401

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/authenticatedips', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ip_address": "text"
    }),
});
const data = await response.json();

Response

401

{
  "message": "text"
}

Pipelines

List all Pipelines

List all account pipelines

GEThttps://api.nimbleway.com/api/v1/account/pipelines

Authorization

bearerAuth

Response

200401404

OK

Body

application/json

namestring

idstring

system_namestring

pipeline_typestring

proxy_passstring

used_gbnumber

spent_requestsinteger

created_atstring

updated_atstring

trafficall of

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

connection_stringstring

optimization_enginearray of string

pipeline_passwordstring

pipeline_usernamestring

proxy_server_addressstring

proxy_server_portinteger

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL as Country code for no country limit

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "name": "text",
    "id": "text",
    "system_name": "text",
    "pipeline_type": "text",
    "proxy_pass": "text",
    "used_gb": 0,
    "spent_requests": 0,
    "created_at": "text",
    "updated_at": "text",
    "traffic": {
      "limit": {
        "amount": 0,
        "limit_type": "text"
      },
      "usage": {
        "bytes": 0,
        "last_reset_date": "text",
        "requests": 0,
        "usd": 0
      }
    },
    "allow_ipv6": false,
    "connection_string": "text",
    "optimization_engine": [
      "text"
    ],
    "pipeline_password": "text",
    "pipeline_username": "text",
    "proxy_server_address": "text",
    "proxy_server_port": 0,
    "session_settings": {
      "ip_rotation_type": "rotating",
      "rotation_time_in_seconds": 0,
      "session_ip_fallback": "replace_ip"
    },
    "status": "text",
    "target_locations": [
      {
        "country_code": "text",
        "state_code": "text",
        "city_code": "text"
      }
    ]
  }
]

Create a new Pipeline

• Pipeline name - Use A-Z, a-z, 0-9 (can include space '.', '-', '_'). Up to 50 characters.
• Target country - Default target country for the pipeline. Will apply to all request that do not specify a target country. Use ISO country code of 2-letter country code i.e. US, DE, BR.
• Session settings configuration: When using rotating type, fallback is required in case a session_id is provided in order to set the behavior in case ip is not available When using fixed_interval type, rotation_time_in_seconds is required in order to set the interval of ip rotation and fallback is required as well for the same reason as above. replace_ip fallback will replace the session's ip to a new one and will keep using it as if it was selected in the first place. keep_asn fallback will find a new ip within the same asn and will keep using it as if it was selected in the first place. fail_request fallback will fail the request.

POSThttps://api.nimbleway.com/api/v1/account/pipelines

Authorization

bearerAuth

Body

application/json

Pipeline

name*string

in swagger indicate wat's optional

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

optimization_enginearray of string

pipeline_passwordstring

pipeline_type*enum

ipdatabrowser

session_settingsall of

Sets the default behavior of the project's session

target_locationsarray of ApiLocation (object)

Use ALL in countryCode for no country limit

Response

201400401404

Created

Body

application/json

namestring

idstring

system_namestring

pipeline_typestring

proxy_passstring

used_gbnumber

spent_requestsinteger

created_atstring

updated_atstring

trafficall of

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

connection_stringstring

optimization_enginearray of string

pipeline_passwordstring

pipeline_usernamestring

proxy_server_addressstring

proxy_server_portinteger

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL as Country code for no country limit

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "pipeline_type": "ip"
    }),
});
const data = await response.json();

Response

201400401404

{
  "name": "text",
  "id": "text",
  "system_name": "text",
  "pipeline_type": "text",
  "proxy_pass": "text",
  "used_gb": 0,
  "spent_requests": 0,
  "created_at": "text",
  "updated_at": "text",
  "traffic": {
    "limit": {
      "amount": 0,
      "limit_type": "text"
    },
    "usage": {
      "bytes": 0,
      "last_reset_date": "text",
      "requests": 0,
      "usd": 0
    }
  },
  "allow_ipv6": false,
  "connection_string": "text",
  "optimization_engine": [
    "text"
  ],
  "pipeline_password": "text",
  "pipeline_username": "text",
  "proxy_server_address": "text",
  "proxy_server_port": 0,
  "session_settings": {
    "ip_rotation_type": "rotating",
    "rotation_time_in_seconds": 0,
    "session_ip_fallback": "replace_ip"
  },
  "status": "text",
  "target_locations": [
    {
      "country_code": "text",
      "state_code": "text",
      "city_code": "text"
    }
  ]
}

Get a single Pipeline

GEThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Response

200401404

OK

Body

application/json

namestring

idstring

system_namestring

pipeline_typestring

proxy_passstring

used_gbnumber

spent_requestsinteger

created_atstring

updated_atstring

trafficall of

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

connection_stringstring

optimization_enginearray of string

pipeline_passwordstring

pipeline_usernamestring

proxy_server_addressstring

proxy_server_portinteger

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL as Country code for no country limit

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "name": "text",
  "id": "text",
  "system_name": "text",
  "pipeline_type": "text",
  "proxy_pass": "text",
  "used_gb": 0,
  "spent_requests": 0,
  "created_at": "text",
  "updated_at": "text",
  "traffic": {
    "limit": {
      "amount": 0,
      "limit_type": "text"
    },
    "usage": {
      "bytes": 0,
      "last_reset_date": "text",
      "requests": 0,
      "usd": 0
    }
  },
  "allow_ipv6": false,
  "connection_string": "text",
  "optimization_engine": [
    "text"
  ],
  "pipeline_password": "text",
  "pipeline_username": "text",
  "proxy_server_address": "text",
  "proxy_server_port": 0,
  "session_settings": {
    "ip_rotation_type": "rotating",
    "rotation_time_in_seconds": 0,
    "session_ip_fallback": "replace_ip"
  },
  "status": "text",
  "target_locations": [
    {
      "country_code": "text",
      "state_code": "text",
      "city_code": "text"
    }
  ]
}

Update a pipeline

Change pipeline's target country, session settings, Ipv6, project quota limit and status

• Session settings configuration: When using rotating type, fallback is required in case a session_id is provided in order to set the behavior in case ip is not available When using fixed_interval type, rotation_time_in_seconds is required in order to set the interval of ip rotation and fallback is required as well for the same reason as above. replace_ip fallback will replace the session's ip to a new one and will keep using it as if it was selected in the first place. keep_asn fallback will find a new ip within the same asn and will keep using it as if it was selected in the first place. fail_request fallback will fail the request.

PATCHhttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Body

application/json

Pipeline

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

optimization_enginearray of string

pipeline_passwordstring

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL in countryCode for no country limit

Response

200400401404

OK

Body

application/json

namestring

idstring

system_namestring

pipeline_typestring

proxy_passstring

used_gbnumber

spent_requestsinteger

created_atstring

updated_atstring

trafficall of

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

connection_stringstring

optimization_enginearray of string

pipeline_passwordstring

pipeline_usernamestring

proxy_server_addressstring

proxy_server_portinteger

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL as Country code for no country limit

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404

{
  "name": "text",
  "id": "text",
  "system_name": "text",
  "pipeline_type": "text",
  "proxy_pass": "text",
  "used_gb": 0,
  "spent_requests": 0,
  "created_at": "text",
  "updated_at": "text",
  "traffic": {
    "limit": {
      "amount": 0,
      "limit_type": "text"
    },
    "usage": {
      "bytes": 0,
      "last_reset_date": "text",
      "requests": 0,
      "usd": 0
    }
  },
  "allow_ipv6": false,
  "connection_string": "text",
  "optimization_engine": [
    "text"
  ],
  "pipeline_password": "text",
  "pipeline_username": "text",
  "proxy_server_address": "text",
  "proxy_server_port": 0,
  "session_settings": {
    "ip_rotation_type": "rotating",
    "rotation_time_in_seconds": 0,
    "session_ip_fallback": "replace_ip"
  },
  "status": "text",
  "target_locations": [
    {
      "country_code": "text",
      "state_code": "text",
      "city_code": "text"
    }
  ]
}

List pipeline rules

Authenticated IPs allow the use of Nimble pipelines without username or password in your proxy settings

GEThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline name

Response

200401

OK

Body

application/json

pipeline_namestring

port_range_end*integer

port_range_start*integer

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "pipeline_name": "text",
  "port_range_end": 0,
  "port_range_start": 0
}

Create a pipeline rule

An authenticated port range can only be used with a single pipeline. Authenticated port will identify the target pipeline in your proxy requests, replacing the need for using username or password

PUThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline name

Body

application/json

Authenticated port range Rule

port_range_end*integer

port_range_start*integer

Response

200401

OK

Body

application/json

authorized_ipsarray of string

idstring

pipeline_rulesarray of whitelist.PipelineRules (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "port_range_end": 0,
      "port_range_start": 0
    }),
});
const data = await response.json();

Response

200401

{
  "authorized_ips": [
    "text"
  ],
  "id": "text",
  "pipeline_rules": [
    {
      "pipeline_name": "text",
      "port_range_end": 0,
      "port_range_start": 0
    }
  ]
}

Delete a rule

Delete a pipeline port range rule

DELETEhttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline name

Response

200401

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/authenticatedips/portrange', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401

{
  "message": "text"
}

Change pipeline password

New password will be automatically generated for the Pipeline

PUThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/password

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Response

200400401404

OK

Body

application/json

namestring

idstring

system_namestring

pipeline_typestring

proxy_passstring

used_gbnumber

spent_requestsinteger

created_atstring

updated_atstring

trafficall of

allow_ipv6boolean

Sets the default behavior of the project to allow the use of ipv6 from peers.

connection_stringstring

optimization_enginearray of string

pipeline_passwordstring

pipeline_usernamestring

proxy_server_addressstring

proxy_server_portinteger

session_settingsall of

Sets the default behavior of the project's session

statusstring

target_locationsarray of ApiLocation (object)

Use ALL as Country code for no country limit

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/password', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400401404

{
  "name": "text",
  "id": "text",
  "system_name": "text",
  "pipeline_type": "text",
  "proxy_pass": "text",
  "used_gb": 0,
  "spent_requests": 0,
  "created_at": "text",
  "updated_at": "text",
  "traffic": {
    "limit": {
      "amount": 0,
      "limit_type": "text"
    },
    "usage": {
      "bytes": 0,
      "last_reset_date": "text",
      "requests": 0,
      "usd": 0
    }
  },
  "allow_ipv6": false,
  "connection_string": "text",
  "optimization_engine": [
    "text"
  ],
  "pipeline_password": "text",
  "pipeline_username": "text",
  "proxy_server_address": "text",
  "proxy_server_port": 0,
  "session_settings": {
    "ip_rotation_type": "rotating",
    "rotation_time_in_seconds": 0,
    "session_ip_fallback": "replace_ip"
  },
  "status": "text",
  "target_locations": [
    {
      "country_code": "text",
      "state_code": "text",
      "city_code": "text"
    }
  ]
}

Summary of daily Pipeline usage

Returns a daily summary of requests and response size (GB)

GEThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/reports/daily-usage

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Query parameters

Response

200401404

OK

Body

application/json

daily_usagesarray of DailyUsage (object)

last_updated_atstring

total_request_gbnumber

total_response_gbnumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/reports/daily-usage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "daily_usages": [
      {
        "date": "text",
        "request_gb": 0,
        "response_gb": 0
      }
    ],
    "last_updated_at": "text",
    "total_request_gb": 0,
    "total_response_gb": 0
  }
]

Last 100 proxy requests made for specific pipeline

GEThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/reports/detailed-requests

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Response

200401404

OK

Body

application/json

account_namestring

client_ipstring

country_codestring

datetimestring

pipelinestring

request_hoststring

request_portinteger

request_sizeinteger

response_sizeinteger

total_sizeinteger

typestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/reports/detailed-requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "account_name": "text",
    "client_ip": "text",
    "country_code": "text",
    "datetime": "text",
    "pipeline": "text",
    "request_host": "text",
    "request_port": 0,
    "request_size": 0,
    "response_size": 0,
    "total_size": 0,
    "type": "text"
  }
]

Sets daily quota limit for a pipeline

Sets a daily limit to prevent pipeline from over spending. Two limit types are available:

• "gb" for limiting the transferred data by GBs
• "credit" for limiting the amount of used credits

POSThttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/spendlimit

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Body

application/json

Limit

amountnumber

type*string

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/spendlimit', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "text"
    }),
});
const data = await response.json();

Response

401404

{
  "message": "text"
}

Deletes the pipelines quota daily limit

DELETEhttps://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/spendlimit

Authorization

bearerAuth

Path parameters

pipelineName*string

Pipeline Name

Response

200401404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/pipelines/{pipelineName}/spendlimit', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "message": "text"
}

Account Status

Get account status

GEThttps://api.nimbleway.com/api/v1/account/remaining-credits

Authorization

bearerAuth

Response

200401404

OK

Body

application/json

billingcontrollers.SubscriptionAccountSection (object)

idstring

namestring

proxy_gateway_namestring

subscription_statusstring

trialscontrollers.TrialAccountSection (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/remaining-credits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "billing": {
    "auto_renewal": false,
    "billing_period_end": "text",
    "billing_period_start": "text",
    "next_payment_date": "text",
    "payment_method": "text",
    "remaining_credits": 0,
    "roll_over": false,
    "spent_credits": 0,
    "subscription_services": [
      {
        "name": "ip",
        "spent_data_in_gb": 0,
        "spent_requests": 0
      }
    ]
  },
  "id": "text",
  "name": "text",
  "proxy_gateway_name": "text",
  "subscription_status": "text",
  "trials": {
    "activeTrials": [
      {
        "free_quota": 0,
        "free_used": 0,
        "name": {},
        "quota_type": "gigabytes",
        "status": "text",
        "trial_end": "text",
        "trial_start": "text"
      }
    ]
  }
}

Summary of daily account usage

Returns a daily summary of requests and response size (GB)

GEThttps://api.nimbleway.com/api/v1/account/reports/daily-usage

Authorization

bearerAuth

Query parameters

Response

200401404

OK

Body

application/json

daily_usagesarray of DailyUsage (object)

last_updated_atstring

total_request_gbnumber

total_response_gbnumber

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/reports/daily-usage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "daily_usages": [
      {
        "date": "text",
        "request_gb": 0,
        "response_gb": 0
      }
    ],
    "last_updated_at": "text",
    "total_request_gb": 0,
    "total_response_gb": 0
  }
]

Last 100 proxy requests made (entire Account)

GEThttps://api.nimbleway.com/api/v1/account/reports/detailed-requests

Authorization

bearerAuth

Response

200401

OK

Body

application/json

account_namestring

client_ipstring

country_codestring

datetimestring

pipelinestring

request_hoststring

request_portinteger

request_sizeinteger

response_sizeinteger

total_sizeinteger

typestring

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/reports/detailed-requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

[
  {
    "account_name": "text",
    "client_ip": "text",
    "country_code": "text",
    "datetime": "text",
    "pipeline": "text",
    "request_host": "text",
    "request_port": 0,
    "request_size": 0,
    "response_size": 0,
    "total_size": 0,
    "type": "text"
  }
]

Global Preferences

Sets custom timeout to an allowed port

• Sets custom timeout to an allowed port, to allow ports contact Nimble admin (the value can range between 10 and 30 seconds)
• Port must be allowed in order to set a custom timeout

POSThttps://api.nimbleway.com/api/v1/account/timeout

Authorization

bearerAuth

Body

application/json

Port and timeout duration in seconds

port*integer

timeout_in_secs*integer

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/timeout', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "port": 0,
      "timeout_in_secs": 0
    }),
});
const data = await response.json();

Response

400

{
  "message": "text"
}

Removes custom timeout to an allowed port

Removes custom timeout to an allowed port

DELETEhttps://api.nimbleway.com/api/v1/account/timeout

Authorization

bearerAuth

Body

application/json

Port to remove its custom timeout

port*integer

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/timeout', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "port": 0
    }),
});
const data = await response.json();

Response

400

{
  "message": "text"
}

Gets a custom timeout for a specific port

Gets a custom timeout for a specific port

GEThttps://api.nimbleway.com/api/v1/account/timeout/{port}

Authorization

bearerAuth

Path parameters

port*string

Port to query its timeout

Response

200400

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/account/timeout/{port}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400

{
  "message": "text"
}

Location

List of supported cities

Gets the list of supported cities in either JSON or HTML table. When using HTML table, addCountriesAndUsStates boolean can be used to add the rest of the supported countries and US states.

GEThttps://api.nimbleway.com/api/v1/location/cities

Authorization

bearerAuth

Query parameters

Response

200400500

OK

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.nimbleway.com/api/v1/location/cities', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

[
  "text"
]