> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/switch-infrastructure/config-manager/_mcp/server.

# Execute IBPKeyCreationWorkflow

POST /v1/workflow/ngc/ib_pkey_creation
Content-Type: application/json

Create an InfiniBand PKey partition on UFM for multi-tenant isolation

Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/switch-infrastructure/config-manager/services/temporal/temporal-api/workflow/ibpkeycreationworkflow-endpoint-v-1-workflow-ngc-ib-pkey-creation-post

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: temporal-api
  version: 1.0.0
paths:
  /v1/workflow/ngc/ib_pkey_creation:
    post:
      operationId: ibpkeycreationworkflow_endpoint_v1_workflow_ngc_ib_pkey_creation_post
      summary: Execute IBPKeyCreationWorkflow
      description: Create an InfiniBand PKey partition on UFM for multi-tenant isolation
      tags:
        - workflow
      parameters:
        - name: Authorization
          in: header
          description: >-
            Bearer JWT used by CLI and machine clients on svc-* endpoints.
            Authentication is required by default, but deployments may disable
            it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE
            identities, and trusted gateway identity headers may also satisfy
            authentication outside this generated client flow.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IBPKeyCreationInput'
components:
  schemas:
    IBPKeyCreationInput:
      type: object
      properties:
        host:
          type: string
          description: Hostname of the UFM server managing the InfiniBand fabric.
        ip_over_ib:
          type: boolean
          default: true
          description: Whether IP over InfiniBand is enabled for the partition.
        pkey:
          type:
            - string
            - 'null'
          description: Partition key to create; automatically allocated when omitted.
        pkey_max:
          type: integer
          default: 32766
          description: Highest partition key eligible for automatic allocation.
        pkey_min:
          type: integer
          default: 1
          description: Lowest partition key eligible for automatic allocation.
        site:
          type:
            - string
            - 'null'
          description: >-
            Site used for UFM credential lookup; resolved from the host when
            omitted.
      required:
        - host
      description: |-
        InfiniBand PKey Creation Workflow Input.

        By default, auto-assigns the next available PKey. Pass an explicit
        ``pkey`` value only when a specific partition key is required.

        ``site`` is optional. When omitted, the workflow resolves the device's
        Site-typed Nautobot location from ``host`` and uses that as the UFM
        credential lookup key. Pass ``site`` explicitly to override the
        auto-resolved value (e.g. for API callers that want to skip the
        Nautobot round-trip).
      title: IBPKeyCreationInput
    WorkflowResponse:
      type: object
      properties:
        href:
          type: string
          description: Calculate URL to Temporal UI Workflow View.
        id:
          type: string
      required:
        - href
        - id
      description: Workflow Response Model.
      title: WorkflowResponse
    ValidationErrorCtx:
      type: object
      properties: {}
      title: ValidationErrorCtx
    ValidationErrorLocItems:
      oneOf:
        - type: string
        - type: integer
      title: ValidationErrorLocItems
    ValidationError:
      type: object
      properties:
        ctx:
          $ref: '#/components/schemas/ValidationErrorCtx'
        input:
          description: Any type
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer JWT used by CLI and machine clients on svc-* endpoints.
        Authentication is required by default, but deployments may disable it
        with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE
        identities, and trusted gateway identity headers may also satisfy
        authentication outside this generated client flow.

```

## Examples



**Request**

```json
{
  "host": "ufm-prod.example.com"
}
```

**Response**

```json
{
  "href": "https://temporal.example.com/workflow/view/123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/v1/workflow/ngc/ib_pkey_creation"

payload = { "host": "ufm-prod.example.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/workflow/ngc/ib_pkey_creation';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"host":"ufm-prod.example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/workflow/ngc/ib_pkey_creation"

	payload := strings.NewReader("{\n  \"host\": \"ufm-prod.example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workflow/ngc/ib_pkey_creation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"host\": \"ufm-prod.example.com\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/workflow/ngc/ib_pkey_creation")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"host\": \"ufm-prod.example.com\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/v1/workflow/ngc/ib_pkey_creation', [
  'body' => '{
  "host": "ufm-prod.example.com"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/v1/workflow/ngc/ib_pkey_creation");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"host\": \"ufm-prod.example.com\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["host": "ufm-prod.example.com"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/workflow/ngc/ib_pkey_creation")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```