Pulse Management Service


BaseUrl
https://pulse.taskcluster.net/v1/

The taskcluster-pulse service, typically available at pulse.taskcluster.net manages pulse credentials for taskcluster users.

A service to manage Pulse credentials for anything using Taskcluster credentials. This allows for self-service pulse access and greater control within the Taskcluster project.

Functions

Using the APIs
SignatureSummary
ping() : voidPing Server
listNamespaces({limit, continuationToken}) : resultList Namespaces
namespace(namespace) : resultGet a namespace
claimNamespace(namespace, payload) : resultClaim a namespace

Ping Server

Method
get
Route
/ping
Signature
ping() : void
Stability
stable

Respond without doing anything. This endpoint is used to check that the service is up.



List Namespaces

(experimental)

Method
get
Route
/namespaces
Signature
listNamespaces({limit, continuationToken}) : result
Stability
experimental

List the namespaces managed by this service.

This will list up to 1000 namespaces. If more namespaces are present a continuationToken will be returned, which can be given in the next request. For the initial request, do not provide continuation token.

Response

List Namespaces Response (source)

Response from a request to list namespaces

namespacesArray of

List of namespaces.

namespacestring

The namespace's name

expiresstringdate-time

Date-time after which the username, and all associated queues and exchanges, should be deleted.

createdstringdate-time

Date-time at which this namespace was first claimed.

continuationTokenstring

A continuation token is returned if there are more results than listed here. You can optionally provide the token as a query parameter to load the additional results.



Get a namespace

(experimental)

Method
get
Route
/namespace/<namespace>
Signature
namespace(namespace) : result
Stability
experimental

Get public information about a single namespace. This is the same information as returned by listNamespaces.

Response

Namespace (source)

Representation of the namespace

namespacestring

The namespace's name

expiresstringdate-time

Date-time after which the username, and all associated queues and exchanges, should be deleted.

createdstringdate-time

Date-time at which this namespace was first claimed.



Claim a namespace

(experimental)

Method
post
Route
/namespace/<namespace>
Scopes
all of
pulse:namespace:<namespace>
Signature
claimNamespace(namespace, payload) : result
Stability
experimental

Claim a namespace, returning a connection string with access to that namespace good for use until the reclaimAt time in the response body. The connection string can be used as many times as desired during this period, but must not be used after reclaimAt.

Connections made with this connection string may persist beyond reclaimAt, although it should not persist forever. 24 hours is a good maximum, and this service will terminate connections after 72 hours (although this value is configurable).

The specified expires time updates any existing expiration times. Connections for expired namespaces will be terminated.

Request Payload

Namespace Creation Request (source)

Namespace creation request

expiresstringdate-time

Date-time after which the username, and all associated queues and exchanges, should be deleted. This can be updated on every claim, with no limit. This should be set to a very short time for temporary credentials (such as for tests), and for a long time (days) for production credentials. It defaults to four hours.

contactstring

E-mail address that will reach people who can address problems with runaway queue length. The service will send warning notifications to this address before forcibly deleting the queue. If omitted, no warnings will be given.

Response

Namespace Claim Response (source)

Namespace claim response

namespacestring

The namespace's name

createdstringdate-time

Date-time at which this namespace was first claimed.

expiresstringdate-time

Date-time after which the username, and all associated queues and exchanges, should be deleted.

connectionStringstring

The AMQP URL for connecting to the pulse service. Note that this URL contains a password, so it should not be logged or displayed to users.

reclaimAtstringdate-time

The caller should plan to call claimNamespace again at this time. The provided password will become invalid a short time after this.