The text of the rulebook

GET

/rulebook/{file}

const url = 'https://example.com/rulebook/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

The rulebook in force, as Markdown, at the URL that signed declarations name.

Authorizations

None

Parameters

Path Parameters

file

required

string

The file name of the version in force.

Responses

200

Markdown.

text/markdown

string

404

Not found.

application/json

The body of every failed call to a management API.

object

error

required

object

code

required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string

message

required

For people; may change between versions.

string

Example

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}