Skip to main content
DELETE
/
v1
/
models
/
{modelId}
/
yaml
Delete a YAML file
curl --request DELETE \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/yaml \
  --header 'Authorization: Bearer <token>'
{
  "fileName": "<string>",
  "success": true
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
modelId
string<uuid>
required

The ID of the model.

Query Parameters

​
fileName
string
required

The name of the YAML file to delete. Valid values are:

​
branchId
string<uuid>

Required if git pull requests are required for the model. The ID of the branch to delete from. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

​
mode
enum<string>
default:combined

The mode to use when deleting the YAML file.

Note: Workbook models must use combined mode if there is a branchId.

Available options:
combined,
extension,
staged,
merged,
history
​
commitMessage
string

Required for git-enabled models. Commit message describing the change.

Response

YAML file deleted successfully

​
fileName
string

The name of the file that was deleted.

​
success
boolean

Indicates the request was successful.