Gateway Response
    • PDF

    Gateway Response

    • PDF

    Article Summary

    Get Gateway Responses

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/responses
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "gatewayResponses" : [ {
        "headers" : [ {
          "responseType" : "responseType",
          "headerName" : "headerName",
          "headerValue" : "headerValue",
          "apiId" : "apiId"
        } ],
        "isDefault" : true,
        "responseType" : "responseType",
        "templates" : [ {
          "mappingTemplate" : "mappingTemplate",
          "responseType" : "responseType",
          "contentType" : "contentType",
          "apiId" : "apiId"
        } ],
        "responseName" : "responseName",
        "apiId" : "apiId",
        "statusCode" : 0
      } ]
    }
    

    Reset custom Gateway Response

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/responses/{response-type}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10
    responseTypepathYStringResponse Type
    Length(Min/Max): 0/45

    Request Body

    • None

    Response Code

    • 204

    Response Body

    • None

    Set gateway response status code

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/responses/{response-type}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10
    responseTypepathYStringResponse Type
    Length(Min/Max): 0/45

    Request Body

    {
      "statusCode" : 0
    }
    

    Response Code

    • 200

    Response Body

    {
      "headers" : [ {
        "responseType" : "responseType",
        "headerName" : "headerName",
        "headerValue" : "headerValue",
        "apiId" : "apiId"
      } ],
      "isDefault" : true,
      "responseType" : "responseType",
      "templates" : [ {
        "mappingTemplate" : "mappingTemplate",
        "responseType" : "responseType",
        "contentType" : "contentType",
        "apiId" : "apiId"
      } ],
      "responseName" : "responseName",
      "apiId" : "apiId",
      "statusCode" : 0
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.