> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.

# Create Connection

POST https://api.bctrl.ai/v1/spaces/{id}/runtimes/{runtimeId}/connections
Content-Type: application/json

Create a short-lived connection lease for a live runtime. Use this to mint credentials for a third-party client that needs to attach to the runtime.

Reference: https://platform.bctrl.ai/api/api-reference/connections/create

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/spaces/{id}/runtimes/{runtimeId}/connections:
    post:
      operationId: runtimes-connections-create
      summary: Create a protocol connection lease into a runtime
      description: >-
        Create a short-lived connection lease for a live runtime. Use this to
        mint credentials for a third-party client that needs to attach to the
        runtime.
      tags:
        - subpackage_spaces
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: runtimeId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/spaces_runtimesConnectionsCreate_Response_200
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  type: object
                  additionalProperties:
                    description: Any type
                protocol:
                  $ref: >-
                    #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostRequestBodyContentApplicationJsonSchemaProtocol
                ttlSeconds:
                  type: integer
              required:
                - protocol
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1SpacesIdRuntimesRuntimeIdConnectionsPostRequestBodyContentApplicationJsonSchemaProtocol:
      type: string
      enum:
        - cdp
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostRequestBodyContentApplicationJsonSchemaProtocol
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint0:
      type: object
      properties:
        type:
          type: string
          enum:
            - websocket
        url:
          type: string
          format: uri
      required:
        - type
        - url
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint0
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint1:
      type: object
      properties:
        baseUrl:
          type: string
          format: uri
        type:
          type: string
          enum:
            - http
      required:
        - baseUrl
        - type
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint1
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint2:
      type: object
      properties:
        host:
          type: string
        password:
          type: string
        port:
          type: integer
        type:
          type: string
          enum:
            - rdp
        username:
          type: string
      required:
        - host
        - password
        - port
        - type
        - username
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint2
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpointOneOf3Endpoints:
      type: object
      properties: {}
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpointOneOf3Endpoints
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint3:
      type: object
      properties:
        endpoints:
          $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpointOneOf3Endpoints
        type:
          type: string
          enum:
            - composite
      required:
        - endpoints
        - type
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint3
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint:
      oneOf:
        - $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint0
        - $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint1
        - $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint2
        - $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint3
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint
    V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaProtocol:
      type: string
      enum:
        - cdp
        - cua
        - rdp
        - vnc
        - mcp
        - http
      title: >-
        V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaProtocol
    spaces_runtimesConnectionsCreate_Response_200:
      type: object
      properties:
        closedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        endpoint:
          $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaEndpoint
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        id:
          type: string
          format: uuid
        protocol:
          $ref: >-
            #/components/schemas/V1SpacesIdRuntimesRuntimeIdConnectionsPostResponsesContentApplicationJsonSchemaProtocol
        revokedAt:
          type:
            - string
            - 'null'
          format: date-time
        runId:
          type: string
          format: uuid
        runtimeId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - active
      required:
        - closedAt
        - createdAt
        - endpoint
        - expiresAt
        - id
        - protocol
        - revokedAt
        - runId
        - runtimeId
        - status
      title: spaces_runtimesConnectionsCreate_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections"

payload = { "protocol": "cdp" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"protocol":"cdp"}'
};

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.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections"

	payload := strings.NewReader("{\n  \"protocol\": \"cdp\"\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.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections")

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  \"protocol\": \"cdp\"\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.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"protocol\": \"cdp\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections', [
  'body' => '{
  "protocol": "cdp"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"protocol\": \"cdp\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["protocol": "cdp"] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/spaces/id/runtimes/runtimeId/connections")! 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()
```