> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runaether.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Set project secret file

> Creates or replaces the secret file whose path the key encodes, answering with its summary; the project's next workspaces are given it.

Use this tool when you need to:
- Add a secret file at a path in a project's workspaces
- Replace a secret file's content

Examples:
- PUT /projects/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/secret-files/Y29uZmlnL3NlY3JldHMuanNvbg {"content": "{\"token\": \"abc\"}"}

Hints:
- projectID is the project's uuid and fileKey the unpadded base64url encoding of the file's UTF-8 project-relative path (LmVudg for .env, Y29uZmlnL3NlY3JldHMuanNvbg for config/secrets.json); the schema answers 422 for a fileKey with any character but letters, digits, underscore and hyphen, padding included, and for a projectID that is not a uuid.
- A fileKey the schema admits that is not the canonical encoding, does not decode to UTF-8, or decodes to an invalid path (one containing .. or starting with /) is 400.
- content is required, at most 1,048,576 characters (422 from the schema otherwise), and may be empty; content over 1 MiB (1,048,576 bytes) in UTF-8 is 400.
- Answers 200 with the SecretFile summary, file_key, file_path, created_at and updated_at, without the content.
- Use bulkUploadProjectSecretFiles instead to write several files by path in one transaction, and getProjectSecretFileContent to read the content back.
- Restricted to an owner or admin of the project's organization: a member is refused with 403 control_forbidden, a viewer or billing member with 403 org_role_insufficient, a suspended organization with 403 org_suspended, and an agent host's grant with 403 agent_host_route_not_allowed; a project that does not exist, is archived or is in an organization the caller does not belong to is 404; 503 when the membership check is unavailable.



## OpenAPI

````yaml api-reference/openapi.json PUT /projects/{projectID}/secret-files/{fileKey}
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /projects/{projectID}/secret-files/{fileKey}:
    put:
      tags:
        - secret-files
      summary: Set project secret file
      description: >-
        Creates or replaces the secret file whose path the key encodes,
        answering with its summary; the project's next workspaces are given it.


        Use this tool when you need to:

        - Add a secret file at a path in a project's workspaces

        - Replace a secret file's content


        Examples:

        - PUT
        /projects/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/secret-files/Y29uZmlnL3NlY3JldHMuanNvbg
        {"content": "{\"token\": \"abc\"}"}


        Hints:

        - projectID is the project's uuid and fileKey the unpadded base64url
        encoding of the file's UTF-8 project-relative path (LmVudg for .env,
        Y29uZmlnL3NlY3JldHMuanNvbg for config/secrets.json); the schema answers
        422 for a fileKey with any character but letters, digits, underscore and
        hyphen, padding included, and for a projectID that is not a uuid.

        - A fileKey the schema admits that is not the canonical encoding, does
        not decode to UTF-8, or decodes to an invalid path (one containing .. or
        starting with /) is 400.

        - content is required, at most 1,048,576 characters (422 from the schema
        otherwise), and may be empty; content over 1 MiB (1,048,576 bytes) in
        UTF-8 is 400.

        - Answers 200 with the SecretFile summary, file_key, file_path,
        created_at and updated_at, without the content.

        - Use bulkUploadProjectSecretFiles instead to write several files by
        path in one transaction, and getProjectSecretFileContent to read the
        content back.

        - Restricted to an owner or admin of the project's organization: a
        member is refused with 403 control_forbidden, a viewer or billing member
        with 403 org_role_insufficient, a suspended organization with 403
        org_suspended, and an agent host's grant with 403
        agent_host_route_not_allowed; a project that does not exist, is archived
        or is in an organization the caller does not belong to is 404; 503 when
        the membership check is unavailable.
      operationId: setProjectSecretFile
      parameters:
        - in: path
          name: projectID
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            The unpadded base64url encoding of the file's UTF-8 project-relative
            path.
          in: path
          name: fileKey
          required: true
          schema:
            description: >-
              The unpadded base64url encoding of the file's UTF-8
              project-relative path.
            pattern: ^[A-Za-z0-9_-]+$
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretFilePutRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFile'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/SecretFilesErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
                  - $ref: '#/components/schemas/ControlForbiddenErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretFilesErrorResponse'
          description: Service Unavailable
components:
  schemas:
    SecretFilePutRequest:
      additionalProperties: false
      properties:
        content:
          maxLength: 1048576
          type: string
      required:
        - content
      type: object
    SecretFile:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          type: string
        file_key:
          pattern: ^[A-Za-z0-9_-]+$
          type: string
        file_path:
          minLength: 1
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - file_key
        - file_path
        - created_at
        - updated_at
      type: object
    SecretFilesErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unavailable
            - aether_inference_unserved
            - agent_connector_not_found
            - agent_default_project_archived
            - agent_profile_changed
            - agent_profile_harness_fixed
            - bad_gateway
            - bad_request
            - conflict
            - connection_agent_only
            - connection_harness_mismatch
            - connection_not_held
            - control_forbidden
            - default_skill_required
            - fallback_is_own_connection
            - fallback_required_with_pin
            - fallback_requires_pin
            - forbidden
            - gateway_timeout
            - gone
            - integration_auth_unexpected
            - integration_not_in_directory
            - integration_shape_changed
            - internal_error
            - mcp_connection_github_not_connected
            - mcp_connection_oauth_not_accepted
            - mcp_connection_org_not_offered
            - mcp_connection_secret_invalid
            - mcp_connection_server_changed
            - mcp_connection_static_secret_not_accepted
            - mcp_credential_policy_not_applicable
            - mcp_credential_policy_org_unavailable
            - mcp_credential_policy_required
            - mcp_oauth_app_auth_method_unsupported
            - mcp_oauth_app_invalid
            - mcp_oauth_app_issuer_invalid
            - mcp_oauth_app_required
            - mcp_oauth_not_advertised
            - mcp_oauth_pkce_unsupported
            - mcp_oauth_registration_failed
            - mcp_repo_config_invalid
            - mcp_server_address_refused
            - mcp_server_aether_managed
            - mcp_server_api_key_not_applicable
            - mcp_server_args_invalid
            - mcp_server_auth_discovery_failed
            - mcp_server_auth_unsupported
            - mcp_server_directory_managed
            - mcp_server_directory_moved
            - mcp_server_display_name_invalid
            - mcp_server_env_invalid
            - mcp_server_headers_invalid
            - mcp_server_key_invalid
            - mcp_server_key_reserved
            - mcp_server_key_taken
            - mcp_server_kind_change_refused
            - mcp_server_not_from_directory
            - mcp_server_not_mcp
            - mcp_server_package_invalid
            - mcp_server_plugin_bundled
            - mcp_server_plugin_off
            - mcp_server_response_too_large
            - mcp_server_return_to_invalid
            - mcp_server_runtime_invalid
            - mcp_server_switched_off
            - mcp_server_unreachable
            - mcp_server_url_invalid
            - mcp_server_version_unpinned
            - method_not_allowed
            - not_acceptable
            - not_found
            - not_implemented
            - org_role_insufficient
            - org_suspended
            - payment_required
            - plugin_moved
            - plugin_name_taken
            - plugin_request_invalid
            - plugin_server_key_reserved
            - plugin_server_key_taken
            - plugin_server_probe_failed
            - plugin_server_required
            - plugin_skill_invalid
            - plugin_source_address_refused
            - plugin_source_empty
            - plugin_source_invalid
            - plugin_source_not_found
            - plugin_source_not_public
            - plugin_source_too_large
            - plugin_source_unreachable
            - plugin_source_unsupported
            - plugin_switched_off
            - plugin_undeliverable
            - precondition_failed
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - service_unavailable
            - skill_slug_reserved
            - unauthenticated
            - unsupported_media_type
            - validation_failed
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    ControlForbiddenErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - control_forbidden
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.