Skip to content

REST API Option

[Side Menu] - [Config and Monitoring] -[REST API Option] to view the AWS API Gateway API Key and Binary Media Type settings.

Tips

API Key

API key is kept in each Debug/Release execution environment. When [Authentication Required] is set to[Required] in the REST API settings, the REST API can be called by specifying the API key in the request header name[X-API-Key].

Copy

The API key shown can be copied.

Update

The API key shown can also be regenerated.

  1. Click the [Update]icon.
  2. Click the [Regenerate Key]icon to regenerate the API key.
  3. Click the [SAVE]button.

Tips

Binary Media Types

When working with binary data in the REST API, the supported binary media types must be set.

The following three types are preconfigured.

  • image/*
  • application/octet-stream
  • multipart/form-data

Configuration Procedure

  1. click [ADD] at the bottom of the Binary Media Type list
  2. Enter the binary media type to be set in the registration dialog.
    To set multiple types, click the [+] button to add a new setting line.
  3. When you are done, click the [APPLY] button.

Binary Media Type List

Registered binary media types are displayed in a list.

UI Dialog

ItemDescription
Binary Media TypeRegistered Binary Media Types
MenuDisplays the following menu.
  • Edit
  • Delete