Account
Get the calling key
Any valid key can call it; no scope is needed. Use it first to learn which scopes the key has, the plan (and Starter trial end), how many agents, metrics, services, SLOs and status pages the plan allows and how many are used, and the organization’s API rate limits.
GET
/
me
Who this API key is: organization, scopes, plan, quotas with usage, rate limits
curl --request GET \
--url https://use.observer/api/v1/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://use.observer/api/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://use.observer/api/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"org": {
"id": "<string>",
"name": "<string>"
},
"key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"scopes": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
},
"plan": {
"slug": "<string>",
"label": "<string>",
"status": "<string>",
"trial_ends_at": "2023-11-07T05:31:56Z",
"billing_enforced": true
},
"quotas": {
"agents": {
"used": 123,
"limit": 123
},
"metrics": {
"used": 123,
"limit": 123
},
"services": {
"used": 123,
"limit": 123
},
"slos": {
"used": 123,
"limit": 123
},
"status_pages": {
"used": 123,
"limit": 123
},
"custom_domains": {
"used": 123,
"limit": 123
},
"customers": {
"used": 123,
"limit": 123
},
"webhook_endpoints": {
"used": 123,
"limit": 123
}
},
"rate_limits": {
"scope": "organization",
"per_minute": 123,
"daily": 123,
"used_today": 123
}
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}Authorizations
An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs.
Was this page helpful?
⌘I
Who this API key is: organization, scopes, plan, quotas with usage, rate limits
curl --request GET \
--url https://use.observer/api/v1/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://use.observer/api/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://use.observer/api/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"org": {
"id": "<string>",
"name": "<string>"
},
"key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"scopes": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
},
"plan": {
"slug": "<string>",
"label": "<string>",
"status": "<string>",
"trial_ends_at": "2023-11-07T05:31:56Z",
"billing_enforced": true
},
"quotas": {
"agents": {
"used": 123,
"limit": 123
},
"metrics": {
"used": 123,
"limit": 123
},
"services": {
"used": 123,
"limit": 123
},
"slos": {
"used": 123,
"limit": 123
},
"status_pages": {
"used": 123,
"limit": 123
},
"custom_domains": {
"used": 123,
"limit": 123
},
"customers": {
"used": 123,
"limit": 123
},
"webhook_endpoints": {
"used": 123,
"limit": 123
}
},
"rate_limits": {
"scope": "organization",
"per_minute": 123,
"daily": 123,
"used_today": 123
}
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}{
"type": "https://docs.use.observer/api/getting-started/errors#forbidden",
"title": "forbidden",
"status": 403,
"detail": "missing scope: write:incidents"
}
