Links
Comment on page

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

post
https://api.nimbleway.com/api
/v1/account/login
Get authentication token
post
https://api.nimbleway.com/api
/v1/account/login/refresh
Get new authentication token

Authenticated IPs

get
https://api.nimbleway.com/api
/v1/account/authenticatedips
List account rules
put
https://api.nimbleway.com/api
/v1/account/authenticatedips
Create a rule
delete
https://api.nimbleway.com/api
/v1/account/authenticatedips
Delete a rule

Pipelines

get
https://api.nimbleway.com/api
/v1/account/pipelines
List all Pipelines
post
https://api.nimbleway.com/api
/v1/account/pipelines
Create a new Pipeline
get
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}
Get a single Pipeline
patch
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}
Update a pipeline
get
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/authenticatedips/portrange
List pipeline rules
put
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/authenticatedips/portrange
Create a pipeline rule
delete
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/authenticatedips/portrange
Delete a rule
put
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/password
Change pipeline password
get
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/reports/daily-usage
Summary of daily Pipeline usage
get
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/reports/detailed-requests
Last 100 proxy requests made for specific pipeline
post
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/spendlimit
Sets daily quota limit for a pipeline
delete
https://api.nimbleway.com/api
/v1/account/pipelines/{pipelineName}/spendlimit
Deletes the pipelines quota daily limit

Account Status

get
https://api.nimbleway.com/api
/v1/account/remaining-credits
Get account status
get
https://api.nimbleway.com/api
/v1/account/reports/daily-usage
Summary of daily account usage
get
https://api.nimbleway.com/api
/v1/account/reports/detailed-requests
Last 100 proxy requests made (entire Account)

Global Preferences

post
https://api.nimbleway.com/api
/v1/account/timeout
Sets custom timeout to an allowed port
delete
https://api.nimbleway.com/api
/v1/account/timeout
Removes custom timeout to an allowed port
get
https://api.nimbleway.com/api
/v1/account/timeout/{port}
Gets a custom timeout for a specific port

Location

get
https://api.nimbleway.com/api
/v1/location/cities
List of supported cities