{
"share": {
"shared": true,
"shareUrl": "http://localhost:3000/share/11111111-1111-4111-8111-111111111111/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"passwordProtected": false
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Send an optional password string."
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Sign in to continue."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "This request origin is not allowed."
}
}{
"error": {
"code": "ARTIFACT_NOT_FOUND",
"message": "Artifact was not found."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred."
}
}Create or update a public share
Creates a public link, or returns the existing one while the current key can still read the token. An optional JSON body { password } sets or replaces the link password. Omitting the password keeps the current one. Passwords are 10 to 128 NFC characters, at least four distinct characters, not all whitespace, and not on the bundled common-password list. Repeating the request without a password returns the same link. Cookie writes require an allowed Origin.
{
"share": {
"shared": true,
"shareUrl": "http://localhost:3000/share/11111111-1111-4111-8111-111111111111/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"passwordProtected": false
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Send an optional password string."
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Sign in to continue."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "This request origin is not allowed."
}
}{
"error": {
"code": "ARTIFACT_NOT_FOUND",
"message": "Artifact was not found."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred."
}
}Authorizations
Factrove API key, usually prefixed ftrv_. Send Authorization: Bearer <key>. Product routes do not accept x-api-key as a credential. A present Authorization header that is not a valid key does not fall back to the session cookie.
Path Parameters
Artifact UUID.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
Optional { password }. No body keeps the current password.
10 - 128Response
The public link and whether it is password protected.
Show child attributes
Show child attributes