Skip to content
forgit api docs

Edit an issue attachment

PATCH
/repos/{owner}/{repo}/issues/{index}/assets/{attachment_id}

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

index
required
integer format: int64

Index of the issue

attachment_id
required
integer format: int64

Id of the attachment to edit

Request Body

Section titled “ Request Body ”
Media type application/json

EditAttachmentOptions options for editing attachments

object
browser_download_url

(Can only be set if existing attachment is of external type)

string
name
string
Example generated 
{
  "browser_download_url": "example",
  "name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Attachment

Media type application/json

Attachment a generic attachment

object
browser_download_url
string
created_at
string format: date-time
download_count
integer format: int64
id
integer format: int64
name
string
size
integer format: int64
type
string
Allowed values: attachment external
uuid
string
Example 
{
  "type": "attachment"
}

404

Section titled “ 404 ”

APIError is error format response

Media type application/json

APIError is an api error with a message

object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

413

Section titled “ 413 ”

QuotaExceeded

Media type application/json

Headers

Section titled “ Headers ”
message
string
user_id
integer format: int64
username
string

423

Section titled “ 423 ”

APIRepoArchivedError is an error that is raised when an archived repo should be modified

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}