/APIs & SDKs/Programs/Update program
PATCH/programs/{program_id}

Update program

Updates the specified program. Configurable properties include the program name, default compute settings, history retention period, and IP allowlist.

Markdown for AI context

Quick start

REST API - curl
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID" \
  -X PATCH \
  -H "Authorization: Bearer $OPTITECH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"program":{"name":"my-production-db"}}'
Also available in
optitech projects update <program_id> --name my-production-db

Parameters

Program ID
program_id
string

The OptiTech program ID

Request body

Basics

commonly setprogram.*
1 field

The program's display name.

Program namecommonprogram.*
name
string

The program name

≥1 chars, ≤256 chars

Compute

program.default_endpoint_settings.*
5 fields

Default compute settings for the program's endpoints.

Program settings

program.*
10 fields

Security, compliance, quotas, retention, and maintenance.

Response

200

Updated the specified program

Depth

Errors

default

General error

This endpoint can return the standard OptiTech API error response.

Response fields

  • message Required. Human-readable error message.
  • code Required. Machine-readable error code.
  • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

Was this page helpful?

On this page

Copy neon init command