# UpdateRemediationNote

## Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

### Headers

```
PUT /api/ss/vulnerability/:vulnerabilityId/remediationNote/:remediationNoteId HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
```

### Query

**vulnerabilityId (string)**

Id of the vulnerability.

Example:

```
PUT /api/ss/vulnerability/5e8ee4657be05608d16c2e01/remediationNote/:remediationNoteId HTTP/1.1
```

**remediationNoteId (string)**

Id of the remediation note.

Example:

```
PUT /api/ss/vulnerability/:vulnerabilityId/remediationNote/5e8017d2e1385f0c58e8f4f8 HTTP/1.1
```

**note (string)**

Remediation note.

Example:

```
{
   "note": "..."
}
```

**note\_type (string) (optional)**

Must be either PLAINTEXT or RICHTEXT. Defaults to PLAINTEXT if not specified.

Example:

```
{
   "note_type": "PLAINTEXT"
}
```

## Example

The following example is a cURL request to update a remediation note on a vulnerability for a project.

### Request

Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' ' parameter.

```
curl -X PUT 'https://demo.attackforge.com/api/ss/vulnerability/5e8ee4657be05608d16c2e01/remediationNote/5e8017d2e1385f0c58e8f4f8' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "note": "This issue has been fixed in release v1.1"
}'
```

### Response

Response contains a status.

```
{
   "status": "ok"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/createremediationnote-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.