REST Resources

/api/space/fabric-management/generate-key

The following operation is supported on this resource:

  • POST - Generate Key
POST /generate-key Version 4

Generate Key.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /generate-key?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    Name Type URI Type Description Required
    queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
    schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <generate-key-request>
         <pass-phrase>String</pass-phrase>
         <algorithm>String</algorithm>
         <key-size>String</key-size>
    </generate-key-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/327680">
      <id>327680</id>
    </task>

  • Sample Input JSON:
    {
       "generate-key-request" : {
         "pass-phrase" : "String" ,
         "algorithm" : "String" ,
         "key-size" : "String"
       }
    }

  • Sample Output JSON:
    {
      "task":{
        "@href":"/api/space/job-management/jobs/327680",
        "id":327680
      }
    }

    • Access Control

    The following capabilities are required to access this API: KeyGenerator