Get one version of a config

GET

https://flags-api.ezghcloud.com/v1/organizations/{orgId}/projects/{projectId}/flags/{flagId}/environments/{environmentId}/versions/{version}

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
format: uuid
projectIdstringrequired
format: uuid
flagIdstringrequired
format: uuid
environmentIdstringrequired
format: uuid
versionintegerrequired
minimum: 1

Returns

200

The version.

JSON

actorobjectrequired
3 properties
- idstringrequired
- namestringrequired
- typestringrequired
commentstringrequired
configobjectrequired
A flag's targeting in one environment, as the history keeps it.
6 properties
- defaultServeobjectrequired
  Exactly one of variation and rollout.
  
  2 properties
  rolloutoptionalobject
  2 properties
  weightsarray ofobjectrequired
  Weights sum to exactly 100000 (0.001 % steps).
  
  2 properties
  variationstringrequired
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
  weightintegerrequired
  maximum: 100000, minimum: 0
  bucketByoptionalstring
  The context attribute to bucket on; targetingKey by default. A context without it gets the first variation.
  
  variationoptionalstring
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
- enabledbooleanrequired
- offVariationstringrequired
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
- rulesarray ofobjectrequired
  Top to bottom, first match wins; at most 100.
  
  4 properties
  clausesarray ofobjectrequired
  ANDed; at most 10.
  
  3 properties
  operatorinornotInorcontainsorstartsWithorendsWithorlt+8 morerequired
  valuesarray ofstring | number | booleanrequired
  Strings, numbers or booleans (booleans with in and notIn); segment keys for the segment operators. At most 1,000.
  
  attributeoptionalstring
  A context attribute; dot paths reach nested ones (company.plan). Absent for segmentMatch and notSegmentMatch.
  
  idstringrequired
  format: uuid
  serveobjectrequired
  Exactly one of variation and rollout.
  
  2 properties
  rolloutoptionalobject
  2 properties
  weightsarray ofobjectrequired
  Weights sum to exactly 100000 (0.001 % steps).
  
  2 properties
  variationstringrequired
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
  weightintegerrequired
  maximum: 100000, minimum: 0
  bucketByoptionalstring
  The context attribute to bucket on; targetingKey by default. A context without it gets the first variation.
  
  variationoptionalstring
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
  descriptionoptionalstring
  maxLength: 200
- targetsarray ofobjectrequired
  Matched on targetingKey, first; at most 10,000 values in all.
  
  2 properties
  valuesarray ofstringrequired
  variationstringrequired
  Lowercase letters, digits, _ and -, starting with a letter or digit; at most 64 characters. Immutable.
  
  pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
- versionintegerrequired
createdAtstringrequired
format: date-time
versionintegerrequired

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.