--- layout: sidebar ---

{{ page.method }}: {{ page.endpoint }}

{{ page.description }}

{{ content }} {%- if page.fields %} application/json {% include api-type.html %} {% endif %} {% assign json_slug = page.slug | append: ".json" -%} {% unless page.empty -%} {% capture request %}{% include requests/{{ page.request | default: json_slug }} %}{% endcapture %} {% endunless -%}
{%- if page.empty %} Does not accept a body {%- else %}

Example Request


          {{ request }}
      
{%- endif %}

Example Curl


          {%- capture headers %}
          {%- unless page.empty %}-H "Content-Type: application/json"
        {%
        endunless %}
          {%- endcapture %}
          $ curl -X{{ page.method }} {{ headers -}}
          http://localhost:8080{{ page.endpoint }}
          {%- unless page.empty %} \
          -d '{{ request | normalize_whitespace }}'
          {%- endunless %}
      
{%- for response in page.responses %} {%- assign status = response.status | default: 200 %} {%- assign file = response.file | default: json_slug %}

Example {{ status }} Response

Status: {{ status }}, Content-Type: application/json {%- if page.response_fields %} {% include api-type.html fields=page.response_fields %} {%- endif %} {%- if file contains ".json" %}

          {% include responses/{{ file }} %}
      
{%- else %} {% include responses/{{ file }} %} {%- endif %}
{%- endfor %}