gatego API documentation

Returns the effective value for a particular setting

GET /api/settings/{name}

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Path parameters

name string Required

name

Query parameters

yardId integer(int64)

yardId

Responses

• 200

OK
Hide response attributes Show response attributes object
- effective_value object
- values object
  
  Hide values attribute Show values attribute
  
  Additional properties: object
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/settings/{name}

curl \
 -X GET https://api-dev.gatego.io:443/api/settings/{name} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "effective_value": {},
  "values": {}
}