API Key
    • PDF

    API Key

    • PDF

    Article Summary

    Create a apiKey

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/api-keys
    

    Request Parameter

    • None

    Request Body

    {
      "apiKeyDescription" : "apiKeyDescription",
      "apiKeyName" : "apiKeyName"
    }
    

    Response Code

    • 201

    Response Body

    {
      "apiKey" : {
        "domainCode" : "domainCode",
        "secondaryKey" : "secondaryKey",
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "isEnabled" : true,
        "modifier" : "modifier",
        "tenantId" : "tenantId",
        "apiKeyDescription" : "apiKeyDescription",
        "apiKeyId" : "apiKeyId",
        "apiKeyName" : "apiKeyName",
        "primaryKey" : "primaryKey"
      }
    }
    

    Delete a api key

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    • None

    Response Code

    • 204

    Response Body

    • None

    Search list of api key

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/api-keys
    

    Request Parameter

    NamePositionRequiredTypeDescription
    offsetquery stringNLongOffset
    Min: 0
    Max: 9,223,372,036,854,775,807
    limitquery stringNLongLimit
    Min: 1
    Max: 9,223,372,036,854,775,807
    apiKeyNamequery stringNStringApi Key Name
    Length(Min/Max): 0/20

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "initialCount" : 0,
      "total" : 6,
      "apiKeys" : [ {
        "domainCode" : "domainCode",
        "secondaryKey" : "secondaryKey",
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "isEnabled" : true,
        "modifier" : "modifier",
        "tenantId" : "tenantId",
        "apiKeyDescription" : "apiKeyDescription",
        "apiKeyId" : "apiKeyId",
        "apiKeyName" : "apiKeyName",
        "primaryKey" : "primaryKey"
      } ]
    }
    

    Search a api key

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "domainCode" : "domainCode",
      "secondaryKey" : "secondaryKey",
      "modTime" : "2000-01-23T04:56:07.000+00:00",
      "isEnabled" : true,
      "modifier" : "modifier",
      "tenantId" : "tenantId",
      "apiKeyDescription" : "apiKeyDescription",
      "apiKeyId" : "apiKeyId",
      "apiKeyName" : "apiKeyName",
      "primaryKey" : "primaryKey"
    }
    

    Search associate product list by api key

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/products
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id
    offsetquery stringNLongOffset
    Min: 0
    Max: 9,223,372,036,854,775,807
    limitquery stringNLongLimit
    Min: 1
    Max: 9,223,372,036,854,775,807

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "total" : 0,
      "apiKeyRelateProductDtos" : [ {
        "publisherId" : "publisherId",
        "regTime" : "2000-01-23T04:56:07.000+00:00",
        "productId" : "productId",
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "productDescription" : "productDescription",
        "productName" : "productName",
        "status" : "REQUEST"
      } ]
    }
    

    Regenerate api key

    URL

    PATCH https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    {
      "keyType" : "PRIMARY"
    }
    

    Response Code

    • 200

    Response Body

    {
      "apiKey" : {
        "domainCode" : "domainCode",
        "secondaryKey" : "secondaryKey",
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "isEnabled" : true,
        "modifier" : "modifier",
        "tenantId" : "tenantId",
        "apiKeyDescription" : "apiKeyDescription",
        "apiKeyId" : "apiKeyId",
        "apiKeyName" : "apiKeyName",
        "primaryKey" : "primaryKey"
      }
    }
    

    Search ApiKey list with Subscribe Status

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/search
    

    Request Parameter

    • None

    Request Body

    {
      "offset" : 6,
      "productId" : "productId",
      "limit" : 0,
      "apiKeyName" : "apiKeyName",
      "statusSet" : [ "REQUEST" ]
    }
    

    Response Code

    • 200

    Response Body

    {
      "total" : 0,
      "apiKeys" : [ {
        "apiKeyDescription" : "apiKeyDescription",
        "apiKeyId" : "apiKeyId",
        "apiKeyName" : "apiKeyName",
        "disabled" : true,
        "permission" : "permission",
        "actionName" : "actionName",
        "status" : "REQUEST"
      } ]
    }
    

    Search product subscription detail by product & apiKey (Own api key)

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id
    Length(Min/Max): 0/10
    offsetquery stringNLongOffset
    Min: 0
    Max: 9,223,372,036,854,775,807
    limitquery stringNLongLimit
    Min: 1
    Max: 9,223,372,036,854,775,807
    apiIdquery stringNStringApi Id
    Length(Min/Max): 0/10
    stageIdquery stringNStringStage Id
    Length(Min/Max): 0/10
    productIdquery stringYStringProduct Id
    Length(Min/Max): 0/10

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "apiKeyRelations" : {
        "total" : 5,
        "content" : [ {
          "apiName" : "apiName",
          "domainCode" : "domainCode",
          "monthlyUsage" : 5,
          "usagePlanId" : "usagePlanId",
          "monthCallCount" : 1,
          "apiKeyId" : "apiKeyId",
          "apiKeyName" : "apiKeyName",
          "usagePlanName" : "usagePlanName",
          "dailyUsage" : 0,
          "regTime" : "2000-01-23T04:56:07.000+00:00",
          "stageName" : "stageName",
          "modTime" : "2000-01-23T04:56:07.000+00:00",
          "dayCallCount" : 6,
          "apiId" : "apiId",
          "stageId" : "stageId"
        } ]
      }
    }
    

    Subscribe product

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscribe
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    {
      "productId" : "productId"
    }
    

    Response Code

    • 200

    Response Body

    • None

    Unsubscribe product

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/unsubscribe
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    {
      "productId" : "productId"
    }
    

    Response Code

    • 200

    Response Body

    • None

    Update a api key's attributes

    URL

    PUT https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}
    

    Request Parameter

    NamePositionRequiredTypeDescription
    apiKeyIdpathYStringApi Key Id

    Request Body

    {
      "isEnabled" : true,
      "apiKeyDescription" : "apiKeyDescription",
      "apiKeyName" : "apiKeyName"
    }
    

    Response Code

    • 200

    Response Body

    {
      "apiKey" : {
        "domainCode" : "domainCode",
        "secondaryKey" : "secondaryKey",
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "isEnabled" : true,
        "modifier" : "modifier",
        "tenantId" : "tenantId",
        "apiKeyDescription" : "apiKeyDescription",
        "apiKeyId" : "apiKeyId",
        "apiKeyName" : "apiKeyName",
        "primaryKey" : "primaryKey"
      }
    }
    

    Was this article helpful?

    What's Next
    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.