Docs API reference

neoserver 0.1.2

Create or replace style asset

PUT /api/v1/workspaces/{workspace}/style-assets/{asset} · Styles

← All operations and schemas
PUT /api/v1/workspaces/{workspace}/style-assets/{asset}

Atomically stores a bounded workspace-local graphic payload.

Operation ID: putStyleAsset

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

  • Authorization: Bearer YOUR_ACCESS_TOKEN
  • X-API-Key: YOUR_API_KEY

Parameters

workspace path required

Workspace ID

string
asset path required

Workspace-local graphic asset name

string

Request body

Required

Content type image/gif

string · binary

Content type image/jpeg

string · binary

Content type image/png

string · binary

Content type image/svg+xml

string · binary

Responses

201 Stored asset

Content type application/json

400 Invalid image

Content type application/json

401 Authentication required or credential rejected

Content type application/json

403 Insufficient permission, disabled login, or invalid CSRF

Content type application/json

413 Asset too large

Content type application/json

426 HTTPS required

Content type application/json

429 Request rate exceeded

Content type application/json

503 Service temporarily unavailable

Content type application/json

OpenAPI operation definition
{
  "description": "Atomically stores a bounded workspace-local graphic payload.",
  "operationId": "putStyleAsset",
  "parameters": [
    {
      "description": "Workspace ID",
      "in": "path",
      "name": "workspace",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Workspace-local graphic asset name",
      "in": "path",
      "name": "asset",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "image/gif": {
        "schema": {
          "format": "binary",
          "type": "string"
        }
      },
      "image/jpeg": {
        "schema": {
          "format": "binary",
          "type": "string"
        }
      },
      "image/png": {
        "schema": {
          "format": "binary",
          "type": "string"
        }
      },
      "image/svg+xml": {
        "schema": {
          "format": "binary",
          "type": "string"
        }
      }
    },
    "required": true
  },
  "responses": {
    "201": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/StyleAsset"
          }
        }
      },
      "description": "Stored asset"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Invalid image"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Authentication required or credential rejected"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Insufficient permission, disabled login, or invalid CSRF"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Asset too large"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "Create or replace style asset",
  "tags": [
    "Styles"
  ]
}

Search documentation

Type to search guides and reference pages.