Skip to main content

Fields

apiType : APIType

The API type effected by this brownout.

disablesRequestsTo : NonEmptyString

For GraphQL APIs this will be a field identifier in the format .≤fieldName>, for REST APIs this will be an endpoint.

endsAt : NonEmptyString

The iso formatted datetime at which this brownout will end.

startsAt : NonEmptyString

The iso formatted datetime at which this brownout will take effect.

The current status of this brownout.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "apiType": "GRAPHQL", "disablesRequestsTo": "available-simply-act-tree-sometimes", "endsAt": "in-rate-field-left-else", "startsAt": "college-member-establish-better-opportunity", "status": "SCHEDULED" }