Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 50 Next »

Overview

Check the list of available endpoints and methods in the Lookups API:

Endpoints and methods

Description

GET /lookup/{domain} see below

Display information on the lookups existing on a given domain.

GET /lookup/{domain}/{name} see below

Return information of a specific lookup.

GET /lookup/{domain}/{name}/job see below

Query the job UUIDs of a specific lookup.

GET /lookup/{domain}/{name}/job/{id} see below

Query the statuses of a lookup job.

POST lookup/{domain}/{name}/deploy-config see below

Create a new lookup.

PUT lookup/{domain}/{name}/deploy-config see below

Update a specific lookup.

DELETE /lookup/{domain}/{name} see below

Send a request to delete a specific lookup.

Endpoints and methods

GET /lookup/{domain}

Display information on the lookups existing on a given domain.

GET /lookup/{domain}/{name}

Return information of a specific lookup.

GET /lookup/{domain}/{name}/job

Query the job UUIDs (Universally Unique IDentifier) of a specific lookup. A new job is created for each create, update or delete process that is initiated. Each job is identified by a unique ID, or UUID.

You will get the last 10 UUIDs for the requested lookup. The list is ordered chronologically being the first job UUID the oldest and the last one the newest.

GET /lookup/{domain}/{name}/job/{id}

Query the statuses of a lookup job given its UUID. You can get a job UUID using the request explained above.

You will get the last 50 statuses for the requested lookup job. The list is ordered chronologically being the first status the oldest and the last one the newest.

These are the possible status codes you may get in your response:

Code

Status

create.start

Lookup creation started.

create.ok

Lookup successfully created.

create.err

Error creating lookup.

push.start

Lookup synchronous upload started.

push.ok

Successful lookup synchronous upload.

push.err

Lookup synchronous upload failed.

deploy.start

Lookup asynchronous upload started.

deploy.ok

Successful lookup asynchronous upload started.

deploy.err

Lookup asynchronous upload failed.

del.start

Lookup deletion started.

del.ok

Lookup successfully deleted.

del.err

Error deleting lookup.

POST /lookup/{domain}/{name}/deploy-config

Create a new lookup.

PUT lookup/{domain}/{name}/deploy-config

Update a specific lookup.

DELETE /lookup/{domain}/{name}

Send a request to delete a specific lookup.

  • No labels