Proxy

APIs used by the ff-proxy

Returns all Proxy keys in an account

Returns all the Proxy keys in an account

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
name	string Name of the field
sortOrder	string SortOrder Enum: "ASCENDING" "DESCENDING"
sortByField	string SortByField Enum: "name" "createdAt" "updatedAt"
pageNumber	integer PageNumber
pageSize	integer PageSize

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/proxy/keys

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"proxyKeys": [{"createdAt": 0,
"description": "This is a proxy key for production",
"id": "31B0B299-7635-416D-9E99-CFCAA7ADABEA",
"identifier": "ProxyKeyOne",
"name": "Proxy Key One",
"updatedAt": 0
}
]
}

Creates a Proxy Key in the account & org

Securityx-api-key

Request

query Parameters

accountIdentifier

required

string

Account Identifier

Examples:

default accountIdentifier=default

Request Body schema: application/json

description	string
identifier required	string
name required	string
required	object (OrganizationDictionary)

Responses

201

Created

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

409

The specified resource already exists

500

Internal server error

post/cf/admin/proxy/keys

Request samples

Payload
curl
Java
Go

application/json

{"description": "A description",
"identifier": "MyProxyKey",
"name": "My Proxy Key",
"organizations": {"org123": {"projects": {"project1": {"environments": [ ],
"scope": "all"
},
"project2": {"environments": [ ],
"scope": "prod"
},
"project3": {"environments": [ ],
"scope": "non-prod"
},
"project4": {"environments": ["env1",
"env2",
"env3"
],
"scope": "selected"
}
}
},
"org456": {"projects": {"project1": {"environments": [ ],
"scope": "all"
},
"project2": {"environments": [ ],
"scope": "prod"
},
"project3": {"environments": [ ],
"scope": "non-prod"
},
"project4": {"environments": ["env1",
"env2",
"env3"
],
"scope": "selected"
}
}
}
}
}

Response samples

application/json

{"key": "0202f58b-d670-44ef-bd1f-323a48c28004"
}

Deletes a ProxyKey

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier

required

string

Account Identifier

Examples:

default accountIdentifier=default

Responses

204

No content

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

424

An error with git syncing

500

Internal server error

delete/cf/admin/proxy/keys/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"code": 404,
"details": { },
"message": "Error retrieving projects, organization 'default_org' does not exist"
}

Returns a ProxyKey

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier

required

string

Account Identifier

Examples:

default accountIdentifier=default

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/proxy/keys/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"createdAt": 1698235128877,
"description": "A description",
"id": "b56546aa-62e6-407e-bf14-63691a47b0e0",
"identifier": "MyProxyKey",
"name": "My Proxy Key",
"organizations": {"org123": {"projects": {"project1": {"environments": [ ],
"scope": "all"
},
"project2": {"environments": [ ],
"scope": "prod"
},
"project3": {"environments": [ ],
"scope": "non-prod"
},
"project4": {"environments": ["env1",
"env2",
"env3"
],
"scope": "selected"
}
}
},
"org456": {"projects": {"project1": {"environments": [ ],
"scope": "all"
},
"project2": {"environments": [ ],
"scope": "prod"
},
"project3": {"environments": [ ],
"scope": "non-prod"
},
"project4": {"environments": ["env1",
"env2",
"env3"
],
"scope": "selected"
}
}
}
},
"updatedAt": 1698235128877
}

Updates a Proxy Key in the account & org

This operation is used to modify which environments a ProxyKey has access to. The request body can include one or more instructions that can assign or unassign environmnets to the ProxyKey

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier

required

string

Account Identifier

Examples:

default accountIdentifier=default

Request Body schema: application/json

object

Responses

200

Created

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

409

The specified resource already exists

500

Internal server error

patch/cf/admin/proxy/keys/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"instructions": {"rotateKey": "12h",
"updateConfig": {"organizations": {"org123": {"projects": {"project1": {"environments": [ ],
"scope": "all"
},
"project2": {"environments": [ ],
"scope": "prod"
},
"project3": {"environments": [ ],
"scope": "non-prod"
},
"project4": {"environments": ["env1",
"env2",
"env3"
],
"scope": "selected"
}
}
}
},
"version": 1
},
"updateDescription": "new proxyKey updateDescription",
"updateName": "newProxyKey"
}
}

Response samples

application/json

{"key": "0202f58b-d670-44ef-bd1f-323a48c28004"
}

➔ Next to Tags