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

# Issue a deployment ingress credential

POST https://api.runtype.com/v1/sandbox-deployments/{id}/ingress-credentials
Content-Type: application/json

Mints one deployment-scoped, invoke-only bearer for the stable ingress hostname. The credential grants HTTP invocation of this deployment only: it never authorizes mutation, secrets, or logs. The plaintext is returned once.

Reference: https://docs.runtype.com/api-reference/runtype-api/sandbox-deployments/issue-a-deployment-ingress-credential

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `displayName` (string, optional)
- `expiresAt` (datetime, optional)

## Response

### 201

Credential issued

- `credential` (V1SandboxDeploymentsIdIngressCredentialsPostResponsesContentApplicationJsonSchemaCredential, required)
- `token` (string, required) — The plaintext bearer. It is returned once and is never recoverable afterwards.

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 402 Payment Required Error

Blocked by the organization managed deployment spend budget or credits

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 404 Not Found Error

Not found

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 409 Conflict Error

Conflict

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 412 Precondition Failed Error

Resource version precondition failed

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 422 Unprocessable Entity Error

Blocked by credential, source, or profile admission

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 429 Too Many Requests Error

Organization quota exhausted

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `details` (list of ErrorDetailsItems, optional)

## Types

### V1SandboxDeploymentsIdIngressCredentialsPostResponsesContentApplicationJsonSchemaCredential

- `createdAt` (string, required)
- `deploymentId` (string, required)
- `displayName` (string, required, nullable)
- `expiresAt` (string, required, nullable)
- `ingressPolicyVersion` (integer, required)
- `lastUsedAt` (string, required, nullable)
- `revokedAt` (string, required, nullable)
- `revokedReason` (string, required, nullable)
- `tokenId` (string, required)
- `tokenPreview` (string, required)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "credential": {
    "createdAt": "2024-06-15T10:23:45Z",
    "deploymentId": "dep_7f3k2m9xqw4v1n8p",
    "displayName": "CI Integration Token",
    "expiresAt": "2024-09-15T10:23:45Z",
    "ingressPolicyVersion": 3,
    "lastUsedAt": "string",
    "revokedAt": "string",
    "revokedReason": "string",
    "tokenId": "tok_4a8b2c6d1e9f3g7h",
    "tokenPreview": "rtk_live_••••••••••••••••3f9a"
  },
  "token": "rtk_live_4a8b2c6d1e9f3g7h5j2k8m1n6p0q4r7s9t3u5v2w8x1y6z"
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/sandbox-deployments/id/ingress-credentials"

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

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

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/sandbox-deployments/id/ingress-credentials';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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.runtype.com/v1/sandbox-deployments/id/ingress-credentials"

	payload := strings.NewReader("{}")

	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.runtype.com/v1/sandbox-deployments/id/ingress-credentials")

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 = "{}"

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.runtype.com/v1/sandbox-deployments/id/ingress-credentials")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/sandbox-deployments/id/ingress-credentials', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/sandbox-deployments/id/ingress-credentials");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/sandbox-deployments/id/ingress-credentials")! 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()
```