Endpoints
apply_share_plan
Apply the unchanged, explicitly approved plan; rechecks current permissions and ETag.
Request
Authentication is required by the published contract.
curl -X POST 'https://api.ursy.cloud/v1/files/{file_id}/share-plans/{share_plan_id}/apply' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_SERVICE_TOKEN'- Scopes
- Not specified by this operation
- Execution
- At the owning service
- Risk classification
- not declared
Parameters
file_id path · string requiredSee the accepted schema for constraints.
share_plan_id path · string requiredSee the accepted schema for constraints.
If-Match header · string requiredSee the accepted schema for constraints.
Idempotency-Key header · string requiredSee the accepted schema for constraints.
This operation is documented here. Use the owning service with the appropriate credentials and permissions to execute it.
Response schemas and request body
{
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Typed operation result; request_id correlates the request.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"properties": {
"share": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"file_id": {
"type": "string",
"pattern": "^file_[1-9][0-9]{0,14}$"
},
"mode": {
"type": "string",
"enum": [
"specific_person",
"link_view",
"link_comment",
"link_edit",
"public_view"
]
},
"url": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"revoked": {
"type": "boolean"
},
"indexable": {
"const": false
}
},
"required": [
"id",
"file_id",
"mode",
"url",
"expires_at",
"revoked",
"indexable"
]
}
},
"required": [
"share"
]
}
}
}
},
"default": {
"description": "Stable error envelope. 401 invalid/expired/revoked grant; 403 missing scope; 404 unavailable resource; 409 plan/idempotency conflict; 412 stale ETag; 413 size/quota; 429 rate limit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}