Neynar Documentation
Delete deployment(s)
cURL
curl --request DELETE \
--url https://api.neynar.com/v2/studio/deployment/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: NEYNAR_API_DOCS' \
--data '
{
"fid": 3,
"deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"namespace": "<string>"
}
'```
### Python
```python
import requests
url = "https://api.neynar.com/v2/studio/deployment/"
payload = {
"fid": 3,
"deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"namespace": "<string>"
}
headers = {
"x-api-key": "NEYNAR_API_DOCS",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {
method: 'DELETE',
headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
body: JSON.stringify({
fid: 3,
deployment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
namespace: '<string>'
})
};
fetch('https://api.neynar.com/v2/studio/deployment/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.neynar.com/v2/studio/deployment/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'fid' => 3,
'deployment_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'namespace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: NEYNAR_API_DOCS"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Go
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.neynar.com/v2/studio/deployment/"
payload := strings.NewReader("{\n \"fid\": 3,\n \"deployment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"namespace\": \"<string>\"}\")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Unirest (Java)
HttpResponse<String> response = Unirest.delete("https://api.neynar.com/v2/studio/deployment/")
.header("x-api-key", "NEYNAR_API_DOCS")
.header("Content-Type", "application/json")
.body("{\n \"fid\": 3,\n \"deployment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"namespace\": \"<string>\"}")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://api.neynar.com/v2/studio/deployment/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fid\": 3,\n \"deployment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"namespace\": \"<string>\"}"
response = http.request(request)
puts response.read_body
Possible Responses
- 200 : Success
{ "success": true, "deletedCount": 123 } - 400 : Bad Request
{ "error": "<string>" } - 404 : Not Found
{ "error": "<string>" } - 500 : Internal Server Error
{ "error": "<string>" }
The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.
Node.js SDK
🔗 SDK Method: deleteDeployment Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.
Authorizations
- x-api-key: Required. API key to authorize requests. Default:
NEYNAR_API_DOCS
Body parameters
- fid: Integer (required). Farcaster ID of the user.
- deployment_id: String (optional). Deployment ID (UUID). Deletes a specific deployment.
- name: String (optional). Kubernetes deployment name.
- namespace: String (optional). Kubernetes namespace.