POST

/restapis/{restapi_id}/models

http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/models

Adds a new Model resource to an existing RestApi resource.

Access Token Required: API Key

Path Parameters

restapi_idstringrequired

The RestApi identifier under which the Model will be created.

Body Params

namestringrequired

The name of the model. Must be alphanumeric.

schemastring

The schema for the model. For <code>application/json</code> models, this should be JSON schema draft 4 model.

contentTypestringrequired

The content-type for the model.

descriptionstring

The description of the model.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/restapis/{restapi_id}/models' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}