Web API Reference Guide > Available API Methods > Administration Methods > The apiKeysAddKey Method

The apiKeysAddKey Method

Add a WebAPI Key.

Version: 1.3

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

name

String

Yes

The name of the key

username

String

Yes

Any username supplied for retrieving ACL information

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: apiKey

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request

POST /ZendServer/Api/apiKeysAddKey

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>apiKeysAddKey</method>

</requestData>

<responseData>

<apiKeys>

<apiKey>

<id>5</id>

<username>developer</username>

<name><![CDATA[MyKey]]></name>

<hash><![CDATA[f2a1854a0641...e9b84f38ae49ef]]></hash>

<creationTime>...</creationTime>

</apiKey>

</apiKeys>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Administration Methods