Skip to content
getgeolens.com
GeoLens Docs

Get Capabilities

GET
/capabilities/
 
curl --request GET \
  --url https://example.com/capabilities/

Describe what this server offers, for a client’s first call.

Anonymous callers get the server, sign-in, basemap, workflow and rate-limit facts. A caller with credentials also gets upload and me.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
CapabilitiesResponse
object
server
required
CapabilitiesServer
object
version
required
Version

Running GeoLens version.

string
edition
required
Edition

Edition the server runs.

string
publish_contract
required
Publish Contract

Version of the publish contract the server speaks.

integer
auth
required
CapabilitiesAuth
object
password_login_enabled
required
Password Login Enabled

Whether username and password sign-in is on.

boolean
methods
required
Methods

Sign-in methods on offer: password plus each enabled provider type.

Array<string>
upload
required
Any of:
CapabilitiesUpload
object
max_file_size_bytes
required
Max File Size Bytes

Largest accepted upload, in bytes.

integer
allowed_extensions
required
Allowed Extensions

Extensions a publish manifest can carry, a subset of the upload allowlist.

Array<string>
presigned
required
Presigned

Whether direct-to-S3 uploads are enabled.

boolean
basemaps
required
Basemaps

Enabled basemaps whose provider key, if any, is configured.

Array<object>
CapabilitiesBasemap
object
id
required
Id

Basemap identifier to use in a map document.

string
name
required
Name

Display name.

string
flags
required
FeatureFlagsResponse

Public feature flags readable by any authenticated user.

object
enable_dataset_editing
Enable Dataset Editing
boolean
require_metadata_for_publish
Require Metadata For Publish
boolean
restrict_public_visibility
Restrict Public Visibility
boolean
status_order
required
Status Order

Dataset workflow statuses, from first to last.

Array<string>
rate_limits
required
CapabilitiesRateLimits
object
global_per_second
required
Global Per Second

Requests per second per client IP.

integer
login_per_minute
required
Login Per Minute

Login attempts per minute.

integer
me
required
Any of:
CapabilitiesMe
object
username
required
Username

Signed-in account.

string
permissions
required
Permissions

Capabilities the account holds.

Array<string>
key
required
Any of:
CapabilitiesKey
object
scope
required
Scope

Scope of the API key making the request.

string
expires_at
required
Any of:
string format: date-time
remaining_dataset_quota
required
Any of:
integer

Example 

{
  "flags": {
    "enable_dataset_editing": false,
    "require_metadata_for_publish": false,
    "restrict_public_visibility": false
  }
}

401

Section titled “ 401 ”

Unauthenticated — a credential was supplied and could not be resolved (expired, revoked, or malformed). Sending no credential at all is not an error on these operations; they answer anonymously with the public subset.

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com