Own Workload? Customize your docs with AI search, analytics, and more.

DELETE

Deletes the specified file from the Compute Node.

https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Access Token Required: API Key

Path Parameters

poolIdstringrequired

The ID of the Pool that contains the Compute Node.

nodeIdstringrequired

The ID of the Compute Node from which you want to delete the file.

filePathstringrequired

The path to the file or directory that you want to delete.

Query Params

recursivestring

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

Deletes the specified file from the Compute Node.

https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Access Token Required: API Key

Path Parameters

poolIdstringrequired

The ID of the Pool that contains the Compute Node.

nodeIdstringrequired

The ID of the Compute Node from which you want to delete the file.

filePathstringrequired

The path to the file or directory that you want to delete.

Query Params

recursivestring

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

Deletes the specified file from the Compute Node.

https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Access Token Required: API Key

Path Parameters

poolIdstringrequired

The ID of the Pool that contains the Compute Node.

nodeIdstringrequired

The ID of the Compute Node from which you want to delete the file.

filePathstringrequired

The path to the file or directory that you want to delete.

Query Params

recursivestring

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

Deletes the specified file from the Compute Node.

https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}

Access Token Required: API Key

Path Parameters

poolIdstringrequired

The ID of the Pool that contains the Compute Node.

nodeIdstringrequired

The ID of the Compute Node from which you want to delete the file.

filePathstringrequired

The path to the file or directory that you want to delete.

Query Params

recursivestring

Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'https://azure.com/pools/{poolId}/nodes/{nodeId}/files/{filePath}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}