Read a connect link
Look up what a connect link points to before a browser joins.
GET
/v1/connect/{token}Auth None. The connect token in the path is the credential.
Push's connect page calls this to show the project and recipient names and to get the key a browser needs to subscribe. You do not need it: send people a connect link instead. Reading a link does not use it up.
Request#
Path parameters#
token
stringrequired
The token at the end of the connect link.
- Rules
cl_followed by 32 letters and digits
Response#
200 OK. Every field is always present.
project.name
stringrequired
The name of the project the link belongs to.
recipient.name
stringrequired
The recipient the browser will join.
vapidPublicKey
stringrequired
The project's public signing key. A browser must subscribe with it as
applicationServerKey.- Rules
- base64url
recipientId
stringrequired
The recipient's id. Push uses it to give each recipient its own service worker scope.
- Rules
- UUID
expiresAt
stringrequired
When the link stops working.
- Rules
- ISO 8601, UTC
usesLeft
integerrequired
How many more browsers can connect with this link.
- Rules
- 0 or more
Errors#
| Code | HTTP | When |
|---|---|---|
| NOT_FOUND | 404 | The token is malformed or unknown, the link expired, was revoked or is used up, or its project is suspended. The message is always “This connect link does not exist, has expired or was used up”. |
| RATE_LIMITED | 429 | More than 60 connect requests a minute from one IP address, counting both connect endpoints. |
| INTERNAL_ERROR | 500 | Something failed on Push's side. It is safe to retry. |
NoteA suspended project's links answer
404, not 403, so a link never reveals why it stopped working.Example#
⫻
curl
⫻
200 OK