Extend REST API documentation with an example of uploading an image attachment using curl #10131

New Issue

adam · 2025-12-29T21:27:15+01:00

adam commented

2025-12-29 21:27:15 +01:00

Originally created by @jeremystretch on GitHub (Aug 22, 2024).

Originally assigned to: @jeremystretch on GitHub.

Change Type

Addition

Area

Integrations/API

Proposed Changes

The process for uploading files via the REST API differs a bit from regular JSON data. A simple copy-and-paste example using curl would be helpful for reference and troubleshooting. For example:

curl -X POST \
-H "Authorization: Token $TOKEN" \
-F "object_type=dcim.site" \
-F "object_id=2" \
-F "name=attachment1.png" \
-F "image=@image.png" \
http://netbox:8000/api/extras/image-attachments/

Originally created by @jeremystretch on GitHub (Aug 22, 2024). Originally assigned to: @jeremystretch on GitHub. ### Change Type Addition ### Area Integrations/API ### Proposed Changes The process for uploading files via the REST API differs a bit from regular JSON data. A simple copy-and-paste example using `curl` would be helpful for reference and troubleshooting. For example: ``` curl -X POST \ -H "Authorization: Token $TOKEN" \ -F "object_type=dcim.site" \ -F "object_id=2" \ -F "name=attachment1.png" \ -F "image=@image.png" \ http://netbox:8000/api/extras/image-attachments/ ```

adam added the status: accepted type: documentation netbox labels 2025-12-29 21:27:15 +01:00

adam closed this issue

2025-12-29 21:27:15 +01:00

adam commented

2025-12-29 21:27:15 +01:00

@github-actions[bot] commented on GitHub (Apr 25, 2025):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Apr 25, 2025): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/main/CONTRIBUTING.md).

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#10131

Extend REST API documentation with an example of uploading an image attachment using curl #10131

Change Type

Area

Proposed Changes

Extend REST API documentation with an example of uploading an image attachment using `curl` #10131